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

Rework reference docs to align to current style guide, doc arch, and improvement proposals #5805

Closed
wants to merge 13 commits into from

Conversation

clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Nov 17, 2023

PR Description

This PR aligns the Agent Flow Reference docs closer to the current style guide and implements several proposals for improvement.

  • Update the placeholder syntax to follow the Style Guide: https://grafana.com/docs/writers-toolkit/write/style-guide/write-for-developers/#placeholder-variables (a decision was made to use <PLACEHOLDER> style.
  • Update the block headings to match the proposal in: Blocks to show parents in docs headers. #5381
    • Sort table content by:
      • Required first
      • Optional sorted alphabetically
    • Remove block from the block subheadings
    • Sort the block descriptions to match the order in the tables
  • Sort other lists alphabetically
  • Update some of the spelling and language used (eg use don't instead of do not, spell out regular expression in descriptive text)
  • Use semantic line breaks wherever possible
  • Remove trailing spaces
  • Remove leading spaces on bullet lists
  • Insert hard returns between headings and body text
  • Fix sentence capitalisation on descriptions in bulleted lists
  • Fix product name capitalisation
  • Fix acronym capitalization
  • Add missing full stops (periods)
  • Remove parenthesis in descriptive text where possible
  • Format tables to be more readable in markdown
  • Add underscore to <AGENT VERSION> syntax to update it to <AGENT_VERSION>

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Nov 17, 2023
Copy link
Contributor

This PR has not had any activity in the past 30 days, so the needs-attention label has been added to it.
If you do not have enough time to follow up on this PR or you think it's no longer relevant, consider closing it.
The needs-attention label signals to maintainers that something has fallen through the cracks. No action is needed by you; your PR will be kept open and you do not have to respond to this comment. The label will be removed the next time this job runs if there is new activity.
Thank you for your contributions!

@github-actions github-actions bot added the needs-attention An issue or PR has been sitting around and needs attention. label Dec 24, 2023
@clayton-cornell
Copy link
Contributor Author

Closing this one. The reference docs are too much in-flux at teh moment to continue with this effort. It can be revisited at a future date.

@clayton-cornell clayton-cornell deleted the docs/rework-block-headings branch January 12, 2024 23:57
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 21, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. needs-attention An issue or PR has been sitting around and needs attention. type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant