GH2917 - Add note on accepted PRs in code and metadata for template #2918
Conversation
lorikrell
added
2.x
Major Update
|
@dshevtsov If you want to verify the metadata for the basic template. |
|
|
||
| Parameter | Description | ||
| --- | --- | ||
| `group:` | The table of contents this file belongs to. Only add the name of the file without the extension. For example, the group of this file is `group: contributor-guide`. |
There was a problem hiding this comment.
Add path to the directory with toc files: _data/toc
And extend the example:
the group of this file is group: contributor-guide, it points to the table of contents defined in _data/toc/contributor-guide.yml
There was a problem hiding this comment.
Updated with the additions. I didn't add this to the tutorial template as it uses different group functions for that toc.
| @@ -12,6 +12,23 @@ The purpose of this page is to provide you with a pre-formatted template and use | |||
|
|
|||
| You can start off by editing the local version of this file using markdown language (and {% glossarytooltip a2aff425-07dd-4bd6-9671-29b7edefa871 %}HTML{% endglossarytooltip %} where needed). Then, create a Pull Request to have your contribution reviewed by the DevDocs team. | |||
|
|
|||
| ## Metadata parameters | |||
|
|
|||
| Add the following {% glossarytooltip 3f0f2ef1-ad38-41c6-bd1e-390daaa71d76 %}metadata{% endglossarytooltip %} parameters at the top of your page. We use this data when generating the DevDocs for the following: | |||
There was a problem hiding this comment.
I don't see metadata in the Glossary
Remove glossarytooltip
There was a problem hiding this comment.
Removed. Also removed it from the tutorial first page file (new in changed files for this PR).
| `title:` | The title of the page. | ||
| `functional_areas:` | Optional. Adds facets for search results. Available facets include: sales, products, carts, customers, marketing, account, content, reports, stores, system, catalog, orders, frontend, theme, staging, search, configurations, integration, services, tools, setup, testing or test, standards, install, upgrade, B2B, cloud, and bundled extensions. |
There was a problem hiding this comment.
The facets are case sensitive.
Update the list with the exact capitalization as defined in our internal wiki list.
There was a problem hiding this comment.
Added that info, and verified all entries match the list.
| @@ -14,12 +14,14 @@ You can start off by editing the local version of this file using markdown langu | |||
|
|
|||
| ## Metadata parameters | |||
|
|
|||
| Add the following {% glossarytooltip 3f0f2ef1-ad38-41c6-bd1e-390daaa71d76 %}metadata{% endglossarytooltip %} parameters at the top of your page. We use this data when generating the DevDocs for the following: | |||
| Add the following metadata parameters at the top of your page. We use this data when generating the DevDocs for the following: | |||
There was a problem hiding this comment.
Add that we use YAML for the metadata in front matter.
There was a problem hiding this comment.
Added note to the opening text.
|
Adding new notes for engcom. Targeting merge for Monday Sept 17th. |
|
Gathering feedback from EngCom for any further changes from their side. Target for publication Sept 17th. |
lorikrell
changed the title
This PR is a:
Summary
When this pull request is merged, it will...
Add a note to the code contributing guide regarding accepted pull requests for 2.2/2.3.
Add a metadata section to the basic template, including the new group for toc.
Additional information
Resolves #2917
whatsnew
Added announcements and supported pull requests for v2.1, v2.2, and v2.3 Contributing guide. Updated the basic template for DevDocs contributions.