podman-desktop icon indicating copy to clipboard operation
podman-desktop copied to clipboard
verified publisher icon containers

Contributing guide for documentation

Open deboer-tim opened this issue 2 years ago • 3 comments

Is your enhancement related to a problem? Please describe

We have a fairly thorough guide on how to contribute source code, test, lint, and run tests locally, but nothing equivalent for the docs.

Describe the solution you'd like

Contributing guide for docs that covers the basics:

  • yarn website:dev
  • pointers to Vale and VS Code extension
  • vale sync
  • vale website
  • yarn format:check
  • yarn format:fix
  • yarn markdownlint:check
  • yarn markdownlint:fix

Describe alternatives you've considered

No response

Additional context

No response

deboer-tim avatar Mar 28 '23 12:03 deboer-tim

I agree, we should add this to CONTRIBUTING.md with regards to any new features / pull requests for documentation.

Especially the website:dev part and the fact that we can also click on Netlify to preview it.

cdrage avatar Oct 13 '23 12:10 cdrage

This issue has been automatically marked as stale because it has not had activity in the last 6 months. It will be closed in 30 days if no further activity occurs. Please feel free to leave a comment if you believe the issue is still relevant. Thank you for your contributions!

github-actions[bot] avatar Apr 11 '24 00:04 github-actions[bot]

Still relevant.

deboer-tim avatar Apr 11 '24 07:04 deboer-tim