Promote Blog Section is not documented

[nouman17610]

The user guide contains no content related to the Promote Section in the Blog. The meta description, slug, and title fields contain information that would appear in search results. This section is important for the Search Engine Optimization (SEO) purpose.

Why Promote Blog Section be documented It is important for users to know about the purpose of promoting a page. Without information, the user may not understand the functionality of the slug and meta description. New users find it difficult to understand the SEO requirements. Effective documentation can reduce the confusion of users while adding details to the Promote page. Different people understand the purpose of slug, title, and meta description differently. They would apply it differently too. To maintain consistency and standardization, it is necessary to add this section to the documentation. So, every person adds the details in these fields with a consistent approach.

How it should be documented? Documentation should follow these steps to document the navigation settings page

• Provide an overview of the promotion page.
• Instruct users by step-by-step approach to add details in the fields.
• Explain to the user about errors and issues during the process
• Offer suggestions for SEO best practices

[nouman17610]

This is how I would approach this issue for documentation.

How to Optimize Your Blog in the Promote Section

The promotion section allows you to optimize your blog to meet SEO requirements for search engines.

Context The promote section has a vital role in indexing and search appearance on search engines. Adding proper details to the title, slug, and meta description helps in improving the SEO, readability, and ranking in search results.

Procedure

1. Access the Promote section On the blog page, click the Promote tab in the left top corner.

A Promote page screen appears that displays the title field, slug field, and meta description field.

2. Click the Slug field and add the slug that you want to see in the URL. Slug contains "-" between each word like [this-is-blog-title]. The slug must contain a focus keyword used in the blog

3. Click the Title Field on the Promote section, and enter the Title tag. The SEO rules suggest that the title should be concise and the best indication of the topic of the blog. The user clicks the link of the heading text in the search results. The title should serve the purpose of best description so the user clicks on the link to see more information.

4. Click the Meta description text area and add a short description of the blog. The meta description appears below the clickable link on search results. The Meta description should contain 2 or 3 lines and summarize the whole content. The focus keyword appears in the first sentence of the Meta description.

5. Select the Show in For site menus check box, if you want to display the link of the blog to automatically generated menus.

6. Click the Save draft button to save the settings for the blog as a draft.

7. If you want to publish the changes, click the arrow icon that appears on the right corner of the button. Select the Publish option to make changes live.

[thibaudcolas]

@nouman17610 could you clarify which page this would appear on? We also need to write this documentation independently of the page type – the "Promote" fields are there for all page types in Wagtail.

The slug must contain a focus keyword used in the blog

Not sure where this recommendation comes from?

There are other recommendations further down in your content that don’t match with how we describe those fields in the UI. If you want to make recommendations on how fields could be used that’s fine, but it needs to be clear what is a description and what is your own speculation. Right now we’re mixing the two.

[nouman17610]

@thibaudcolas It is better to document this independently of any specific page category. The promote section appears on every page you create.

I am trying to provide details to the user about completing the task and meeting SEO requirements too.

The purpose of the promote section is to improve SEO so I am suggesting meeting 2 objectives within 1 document.

For example: The Slug structure would be like this [my-slug] at the end of the URL. The inclusion of a focus keyword in the Slug is an SEO requirement.

If it is confusing for the user to read 2 task directions and SEO requirements. We can keep them separate.

[nouman17610]

Final draft

Manage the promote section on the page.

1. Go to Pages on the left sidebar, click Pages > Root > Add child page, or edit an existing page.
2. On the edit page, access the Promote section. On the blog page, click the Promote tab in the left-top corner.

3. Add details

   

• Click the slug field and add the Slug you want to see in the URL. Slug contains "-" between each word, like [this-is-blog-title].
• Click the Title Field on the Promote Section and enter the Title tag. The title should serve the purpose of best description, so the user clicks on the link to see more information.
• Click the Meta description text area and add a short description. The Meta description should contain 2 or 3 lines and summarise the whole content.
• Select the Show in site menus checkbox if you want to display the blog link to automatically generate menus.

4. Click the Save draft button to save the settings for the blog as a draft.
5. If you want to publish the changes, click the arrow icon, which appears on the right corner of the button. Select the Publish option to make changes live.