Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use document references instead of anchors #7487

Merged
merged 1 commit into from
Jul 2, 2024

Conversation

GGP1
Copy link
Member

@GGP1 GGP1 commented Jun 28, 2024

Description

Replaces AWS supported services index :ref references to :doc: and removed their related anchors from the different files.

Checks

Docs building

  • Compiles without warnings.
Build
...
Running Sphinx v7.0.1
loading translations [en-US]... not available for built-in messages
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] cloud-security/amazon/services/supported-services/index
Copying static files for wazuh-doc-images...[100%] img/loading.gif             
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index                                                 x
generating indices... done
writing additional pages... not_found moved-content search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in home/python/build/html.
[sphinx-autobuild] Serving on http://0.0.0.0:8000

Code formatting and web optimization

  • Uses three spaces indentation.
  • Adds or updates meta descriptions accordingly.
  • Updates the redirects.js script if necessary (check this guide).

Writing style

  • Uses present tense, active voice, and semi-formal registry.
  • Uses short, simple sentences.
  • Uses bold for user interface elements, italics for key terms or emphasis, and code font for Bash commands, file names, REST paths, and code.

@GGP1 GGP1 self-assigned this Jun 28, 2024
@GGP1 GGP1 linked an issue Jun 28, 2024 that may be closed by this pull request
Copy link
Member

@nico-stefani nico-stefani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@javimed javimed added type/enhancement Enhancement issue level/task Task issue labels Jul 2, 2024
@javimed javimed merged commit 53d9479 into 4.8.1 Jul 2, 2024
3 checks passed
@javimed javimed deleted the enhancement/7165-use-document-references branch July 2, 2024 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/enhancement Enhancement issue
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Modify AWS supported services index
3 participants