Skip to content
D
Documentation

Edit an article

task
3 min readUpdated

An article record is the saved article page. Its editor is the article editing page. An existing article is one you open and change in the article editor. Use this page when you need to update its title, description, body, or tags, or when you need to remove it as its author. For a new article, see Create an article.

If you need to…Go to
Open an existing articleFind and open the article
Identify the fields and tag controlsUnderstand the editor
Change and submit an articleEdit and save the article
Remove an articleDelete the article
Read an article after editingRead an article
Handle general error messagesGeneral error messages
Resolve a common issueCommon issues and solutions

Before you start

Prerequisites

  • Have an authenticated account.
  • Have an existing article to edit.
  • Be the article's author to see Edit Article and Delete Article.
  • Open the saved article record before starting the edit.

Find and open the article

Prerequisites

  • Meet the prerequisites above.

Steps

  1. Open the existing article record.
  2. Select Edit Article.

The article editor opens for that article.

Result: The existing article is open in its editor.

Understand the editor

The four reader-facing strings in the editor are placeholders.

What you need to changeControlWhat you use it for
TitleArticle TitleChange the article title.
DescriptionWhat's this article about?Change the article description.
BodyWrite your article (in markdown)Change the article body.
TagsEnter tagsAdd a tag by entering it and pressing Enter.
Tagsclose icon beside a tagRemove that tag.
SubmissionPublish ArticleSubmit the existing article edit.

While the submission is in progress, the editor fields and Publish Article are disabled.

Result: You can identify each field, the tag actions, and the control that submits the edit.

Edit and save the article

Editing an article changes the existing values in the article editor and submits them through Publish Article.

Prerequisites

  • Meet the prerequisites above and have the article editor open.

Steps

  1. Enter the new title in Article Title.

  2. Enter the new description in What's this article about?.

  3. Enter the article text in Write your article (in markdown).

  4. Use one of these tag actions:

    If you need to…Action
    Add a tagEnter the tag in Enter tags, then press Enter.
    Remove a tagSelect the close icon beside that tag.
  5. Select Publish Article.

After a successful edit request, the application opens the returned article.

Result: The edited article is displayed on its article page.

Delete the article

Delete Article is the author-only action that removes the article and takes you away from its article page after the delete request succeeds.

Prerequisites

  • Meet the prerequisites above and have the article record open.

Steps

  1. Select Delete Article in the article actions.

After the delete request succeeds, the application returns to the Home page.

Result: The Home page is displayed after the article is deleted.

When the edit does not work

The error list shows each returned error key and message value verbatim. The fields have no visible required or pattern rule.

What appearsWhat it meansWhat to do
The returned error key and message valueThe edit request returned an error.Read the displayed entry and correct the related article value before selecting Publish Article again.

After editing or deleting

After a successful edit, the application opens the returned article. After a successful deletion, the application returns to the Home page. To continue reading the article, open Read an article.

Was this page helpful?

Download as PDF
Edit an article — Conduit (Vue)