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

Create Wiki with documentation of rules and categories #21

Closed
6 of 8 tasks
bvobart opened this issue Jun 21, 2021 · 0 comments · Fixed by #26
Closed
6 of 8 tasks

Create Wiki with documentation of rules and categories #21

bvobart opened this issue Jun 21, 2021 · 0 comments · Fixed by #26
Assignees

Comments

@bvobart
Copy link
Owner

bvobart commented Jun 21, 2021

Currently, you have to run mllint list all and mllint describe some-slug to get information about a rule. It would be better if mllint's CI would auto-generate some content for a website on this repo at every release.

Idea:
- Implement generating Markdown version of Wiki page containing docs on every rule and category in mllint.
- Use this Wiki page creator action to generate a Wiki page from the mllint generated Markdown code.

Tasks:

  • Look into and set up Github Pages
  • Create a basic website (using Hugo)
  • Find a good theme (PaperMod)
  • Write some content for any other pages.
  • Implement a script to generate Hugo content from rules & categories descriptions
  • Set up CI pipeline to automatically deploy the website on pushes to master or on tagged releases.
  • Update ReadMe with link to website.
  • Merge to master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant