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

docs: cleanup and normalization #2636

Merged
merged 61 commits into from
Feb 1, 2024

Conversation

reubenmiller
Copy link
Contributor

@reubenmiller reubenmiller commented Jan 30, 2024

Proposed changes

Updating the docs to use consistent:

  • title
  • file names
  • anchors
  • references to thin-edge.io (product name)
  • Use title case for page headings
  • Add page descriptions (to control which text is shown in the DocCardList previews and the html's meta description field for SEO)
  • Page side bar order (at least in places where the side bar is not a user targeted sequence of steps)

Along the way a few minor things have been addressed (apologies for mixing it in)

  • Disable image zoom on images which don't make sense (e.g. cloudsmith package links)
  • Fix minor grammar mistakes (e.g. missing words, or missing plural form)

Future work

A new ticket has been created to address some additional cleanup items (which won't be included in this already too large PR):

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Signed-off-by: Reuben Miller <[email protected]>
Signed-off-by: Reuben Miller <[email protected]>
Signed-off-by: Reuben Miller <[email protected]>
Signed-off-by: Reuben Miller <[email protected]>
Signed-off-by: Reuben Miller <[email protected]>
Signed-off-by: Reuben Miller <[email protected]>
Copy link
Contributor

github-actions bot commented Jan 31, 2024

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
385 0 3 385 100 54m56.619s

Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

This is a real step forward. I have some comments and questions though.

docs/src/operate/c8y/health-monitoring.md Outdated Show resolved Hide resolved
docs/src/operate/c8y/custom_fragments.md Outdated Show resolved Hide resolved
docs/src/operate/c8y/custom-fragments.md Outdated Show resolved Hide resolved
docs/src/operate/c8y/custom-fragments.md Outdated Show resolved Hide resolved
docs/src/install/index.md Show resolved Hide resolved
docs/src/contribute/design/mqtt-topic-design.md Outdated Show resolved Hide resolved
docs/src/operate/index.md Show resolved Hide resolved
docs/src/operate/troubleshooting/index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

Approved. A great step forward, making the docs easier to discover and navigate.

@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label Feb 1, 2024
@reubenmiller reubenmiller changed the title doc: cleanup and normalization docs: cleanup and normalization Feb 1, 2024
@reubenmiller reubenmiller added this pull request to the merge queue Feb 1, 2024
Merged via the queue into thin-edge:main with commit 8eba2b6 Feb 1, 2024
18 checks passed
@reubenmiller reubenmiller deleted the docs-reshuffle-docs branch July 18, 2024 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants