search

phac-nml / irida-next

IRIDA Next
https://phac-nml.github.io/irida-next/
Apache License 2.0
8 stars 2 forks source link

docs: Scaffold user docs #610

Closed ChrisHuynh333 closed 1 month ago

ChrisHuynh333 commented 1 month ago

What does this PR do and why?

This PR adds the initial scaffold to the user documentation, providing the initial layout so other contributors know where to add their documentation.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other pull requests.

How to set up and validate locally

  1. Start the docs in a terminal within your irida-next repo with: 
    cd docs-site
pnpm build
npm run serve
  2. Ensure the docs and provisional headers look correct.

PR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

ChrisHuynh333 commented 1 month ago

Quick comment about adding a couple of pages:

Can we add pages for Bot Accounts underneath http://localhost:4000/irida-next/docs/user/organization/groups/ and http://localhost:4000/irida-next/docs/user/project/projects/

  • Purpose of bot accounts
  • Type of bot accounts
  • How to manage (add/remove) bot accounts, as well as, adding/removing memberships.
  • View/Generate/Revoke personal access tokens for bot accounts

Note: A group bot that is created in a group can be added as a member to other projects/groups (global). However, a project bot can only be associated to the project it was created within

Added in a937584499656ea7b900ad230860ac8e80fb8bee. Let me know if this isn't what you envisioned!

github-actions[bot] commented 1 month ago

Simplecov Report

Covered Threshold
92.41% 90%