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 section to Documentation Style Guide recommending linking terms to glossary [DOCS] #2153

Open
mjanowiecki opened this issue Aug 11, 2022 · 0 comments
Labels
Type: documentation provides documentation or asks for documentation.

Comments

@mjanowiecki
Copy link
Contributor

  • If applicable, link to the documentation page relevant to your issue below.

    Documentation Style Guide Do's

  • Describe your documentation request.

    As discussed in the Documentation Interest Group on 2022-08-10, we are hoping to add a small section to the Documentation Style Guide recommending that contributors link applicable terms back to the glossary when writing documentation. This will help users quickly understand the context of the term if it is unfamiliar to them.

  • Which version of islandora are you using?

    Islandora 8 (the most recent version)

  • What user roles is this documentation intended for?

    This documentation will help anyone using the Documentation wiki.

  • What implementations of islandora does this documentation request apply to?

    This only applies to the Documentation wiki.

  • Any related open or closed issues to this bug report?

    I found some issues related to adding additional glossary terms, but none on this particular issue.

Screenshots:

@mjanowiecki mjanowiecki added the Type: documentation provides documentation or asks for documentation. label Aug 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: documentation provides documentation or asks for documentation.
Projects
None yet
Development

No branches or pull requests

1 participant