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

Add dedicated documentation for updates to documentation only #3099

Open
BernieWhite opened this issue Oct 12, 2024 · 3 comments
Open

Add dedicated documentation for updates to documentation only #3099

BernieWhite opened this issue Oct 12, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@BernieWhite
Copy link
Collaborator

No description provided.

@BernieWhite BernieWhite added the documentation Improvements or additions to documentation label Oct 12, 2024
@that-ar-guy
Copy link
Contributor

Hey @BernieWhite can i take this up

@BernieWhite
Copy link
Collaborator Author

BernieWhite commented Feb 11, 2025

Thanks @that-ar-guy. To provide a little more detail, this should be a walk through / tutorial style as a follow up to https://azure.github.io/PSRule.Rules.Azure/license-contributing/writing-documentation/.

We want to add a page that helps and guides someone to make updates to the documentation just like you have been doing but also the rule documentation.

Some of this is already in contributing.md and https://azure.github.io/PSRule.Rules.Azure/license-contributing/writing-documentation/. But there are also things that might not be clear for a new contributor. Try to think back to what you would have like to know when you got started.

This page should be under the Writing documentation page in the navigation here as part of the License and contributing.

Maybe call it: Getting started with documentation.

@that-ar-guy
Copy link
Contributor

Hey @BernieWhite,

Thanks for the details! Here’s how I plan to proceed with the "Getting Started with Documentation" guide:

✅ Plan of Action:

  • Create a new Markdown file at docs/license-contributing/getting-started-with-documentation.md.

  • Structure the guide as a tutorial, covering:

    • Introduction to contributing to documentation
    • Finding and updating documentation files
    • Writing and improving rule documentation
    • Previewing changes locally
    • Submitting a PR with best practices
    • Common issues and troubleshooting
  • Ensure it aligns with the existing Writing Documentation guide and fills in gaps that may not be clear for new contributors.

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

No branches or pull requests

2 participants