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

Remove cruft and update contribute to documentation to current standards #1788

Open
wants to merge 2 commits into
base: 6.0
Choose a base branch
from

Conversation

stevepiercy
Copy link
Contributor

@stevepiercy stevepiercy commented Nov 23, 2024

I couldn't stop myself. There was so much yuck.

Closes #1779.

  • Move update git submodules to Administrators guide from index.md
  • Update Vale instructions with latest release
  • Use linkcheckbroken to check links instead of linkcheck
  • Add instructions for how to ignore links
  • Add note admonition about suboptimal lexers
  • Improve usage of html_meta
  • Add Diátrix Framework description
  • Overhaul index.md to better direct readers to the right starting point
  • Purge Contributor roles
  • Remove redundant Documentation quality requirements
  • Simplify processes for how to contribute via GitHub website and local editor
  • Update make commands to most frequently used, with instructions for all commands
  • Add glossary terms

📚 Documentation preview 📚: https://plone6--1788.org.readthedocs.build/

- Move update git submodules to Administrators guide from index.md
- Update Vale instructions with latest release
- Use linkcheckbroken to check links instead of linkcheck
- Add instructions for how to ignore links
- Add note admonition about suboptimal lexers
- Improve usage of `html_meta`
- Add Diátrix Framework description
- Overhaul index.md to better direct readers to the right starting point
- Purge Contributor roles
- Remove redundant Documentation quality requirements
- Simplify processes for how to contribute via GitHub website and local editor
- Update make commands to most frequently used, with instructions for all commands
- Add glossary terms
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Approved
Development

Successfully merging this pull request may close these issues.

Revise Contributing to Documentation page
2 participants