From ef63203e61ad25979c8368c6731592cc099ea648 Mon Sep 17 00:00:00 2001 From: srawat <120587655+SwRaw@users.noreply.github.com> Date: Thu, 19 Dec 2024 19:46:13 +0530 Subject: [PATCH] docs: Fixing metadata --- .wordlist.txt | 3 +++ docs/developer_guide/commitizen.md | 7 +++++++ docs/developer_guide/dependabot.md | 7 +++++++ docs/developer_guide/developer_guide.md | 7 +++++++ docs/developer_guide/just.md | 7 +++++++ docs/developer_guide/projects_yaml.md | 7 +++++++ docs/developer_guide/python_linting.md | 7 +++++++ docs/index.md | 7 +++++++ docs/user_guide/article_info.md | 7 +++++++ docs/user_guide/linking.md | 7 +++++++ docs/user_guide/linking_md.md | 7 +++++++ docs/user_guide/linking_rst.rst | 5 +++++ docs/user_guide/linking_toc.md | 7 +++++++ docs/user_guide/linting.md | 7 +++++++ docs/user_guide/spellcheck.md | 7 +++++++ docs/user_guide/user_guide.md | 7 +++++++ 16 files changed, 106 insertions(+) diff --git a/.wordlist.txt b/.wordlist.txt index 0aeba450..f422f938 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -544,6 +544,7 @@ hipsparse hpp hsa hsakmt +html hyperparameter ib_core inband @@ -556,6 +557,7 @@ inlining installable instantiation interprocedural +intersphinx intra invariants invocating @@ -583,6 +585,7 @@ mkdir mlirmiopen mtypes mvffr +myst namespace namespaces natively diff --git a/docs/developer_guide/commitizen.md b/docs/developer_guide/commitizen.md index 7f4548ba..0022376b 100644 --- a/docs/developer_guide/commitizen.md +++ b/docs/developer_guide/commitizen.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "Commitizen enforces conventional commits and implements automatic release tagging based on commit messages." + "keywords": "Commit, Conventional commit, Commit messages, Commit using Commitizen, Commitizen, Documentation configuration" +--- + # Commitizen The ROCm Docs Core repository uses diff --git a/docs/developer_guide/dependabot.md b/docs/developer_guide/dependabot.md index f348d848..215879c0 100644 --- a/docs/developer_guide/dependabot.md +++ b/docs/developer_guide/dependabot.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "Dependabot is automated dependency management tool" + "keywords": "Automated dependency management tool, Dependency management, Dependabot, Documentation dependencies" +--- + # Dependabot Dependabot is automated dependency management tool. diff --git a/docs/developer_guide/developer_guide.md b/docs/developer_guide/developer_guide.md index 7283be9f..1df1e1b5 100644 --- a/docs/developer_guide/developer_guide.md +++ b/docs/developer_guide/developer_guide.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "A collection of utilities, styling, scripts, and additional HTML content common to all ROCm projects’ documentation" + "keywords": "Documentation processes, Documentation toolchains, Documentation configuration" +--- + # Developer Guide The Developer Guide provides additional information on the processes and toolchains in `rocm-docs-core` diff --git a/docs/developer_guide/just.md b/docs/developer_guide/just.md index 07a12af1..657b5d37 100644 --- a/docs/developer_guide/just.md +++ b/docs/developer_guide/just.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "Just is a command runner used to quickly setup an environment for documentation development" + "keywords": "Documentation development environment, Environment for documentation development, Just, Documentation configuration" +--- + # Just [`just`](https://github.com/casey/just) is a command runner used to diff --git a/docs/developer_guide/projects_yaml.md b/docs/developer_guide/projects_yaml.md index ba8c2134..529e3be7 100644 --- a/docs/developer_guide/projects_yaml.md +++ b/docs/developer_guide/projects_yaml.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "Defining external intersphinx project mapping" + "keywords": "Intersphinx, project mapping, Documentation configuration" +--- + # External Intersphinx Project Mapping Projects should be defined in `projects.yaml` and should set which key they correspond to by setting external_projects_current_project to this key. diff --git a/docs/developer_guide/python_linting.md b/docs/developer_guide/python_linting.md index bb91999b..38d538a8 100644 --- a/docs/developer_guide/python_linting.md +++ b/docs/developer_guide/python_linting.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "Tools used for checking correctness in Python code" + "keywords": "Python linting tool, Error checker, Documentation configuration" +--- + # Python Linting The following list of tools is used for checking correctness in Python code. diff --git a/docs/index.md b/docs/index.md index 2e854fe4..b87eca02 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "A collection of utilities, styling, scripts, and additional HTML content common to all ROCm projects’ documentation" + "keywords": "ROCm documentation configuration, ROCm documentation customization, ROCm documentation tool, ROCm docs core developer guide" +--- + # ROCm Docs Core ROCm Docs Core is a collection of utilities, styling, scripts and additional diff --git a/docs/user_guide/article_info.md b/docs/user_guide/article_info.md index ca76de12..8b4609e3 100644 --- a/docs/user_guide/article_info.md +++ b/docs/user_guide/article_info.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "Setting article info in ROCm documentation" + "keywords": "Documentation settings, Display document information, Display article metadata, Display document metadata" +--- + # Article Info Article info is disabled by default and must be enabled in `conf.py`. diff --git a/docs/user_guide/linking.md b/docs/user_guide/linking.md index 2ddb3b8b..372d5a07 100644 --- a/docs/user_guide/linking.md +++ b/docs/user_guide/linking.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "Setting up links to other projects, current project and external sites in ROCm documentation" + "keywords": "Adding links, Project linking, Project reference, Documentation settings" +--- + # Linking [Markdown](./linking_md) diff --git a/docs/user_guide/linking_md.md b/docs/user_guide/linking_md.md index c4180785..be827a39 100644 --- a/docs/user_guide/linking_md.md +++ b/docs/user_guide/linking_md.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "Setting up links in Markdown to other projects, current project and external sites in ROCm documentation" + "keywords": "Markdown links, Project linking, Project reference, Adding links in Markdown, Documentation settings" +--- + # Linking in Markdown ## Markdown diff --git a/docs/user_guide/linking_rst.rst b/docs/user_guide/linking_rst.rst index 18e35d78..75657008 100644 --- a/docs/user_guide/linking_rst.rst +++ b/docs/user_guide/linking_rst.rst @@ -1,3 +1,8 @@ +.. meta:: + :description: Setting up links in RST to other projects, current project and external sites in ROCm documentation + :keywords: RST links, Project linking, Project reference, Adding links in RST, Documentation settings + + Linking in RST ============== diff --git a/docs/user_guide/linking_toc.md b/docs/user_guide/linking_toc.md index 283017f1..79dd396a 100644 --- a/docs/user_guide/linking_toc.md +++ b/docs/user_guide/linking_toc.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "Setting up links in the Table of Contents for ROCm documentation" + "keywords": "Links in TOC, Links in table of content, Documentation TOC, Documentation table of content, Document index, Documentation settings" +--- + # Linking in the Table of Contents ## Syntax diff --git a/docs/user_guide/linting.md b/docs/user_guide/linting.md index 1d682197..a832f468 100644 --- a/docs/user_guide/linting.md +++ b/docs/user_guide/linting.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "Linting ensures correct Markdown and ReStructuredText formatting on every pull request" + "keywords": "Formatting PR, Formatting pull requests, Linting checks, Documentation settings" +--- + # Linting `rocm-docs-core` has linting to ensure correct Markdown and ReStructuredText diff --git a/docs/user_guide/spellcheck.md b/docs/user_guide/spellcheck.md index d6f696f8..d768884e 100644 --- a/docs/user_guide/spellcheck.md +++ b/docs/user_guide/spellcheck.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "Rocm docs core has spell checks run on every pull request" + "keywords": "Spell check in ROCm documentation, Spell check in ROCm docs core, ROCm docs core user guide" +--- + # Spell Check `rocm-docs-core` has spell checks run on every pull request (PR) via GitHub Actions. diff --git a/docs/user_guide/user_guide.md b/docs/user_guide/user_guide.md index bcccaeba..7c0f9f92 100644 --- a/docs/user_guide/user_guide.md +++ b/docs/user_guide/user_guide.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "The user guide describes how users can make use of functionalities in ROCm docs core" + "keywords": "ROCm docs core functionalities, Documentation settings" +--- + # User Guide The User Guide describes how users can make use of functionality in `rocm-docs-core`