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.

Sign up for GitHub

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

Jump to bottom

Docs: Project and Sample #623

Merged
merged 8 commits into from
Jun 20, 2024
Merged

Docs: Project and Sample #623

merged 8 commits into from
Jun 20, 2024

Conversation

ChrisHuynh333
Copy link
Collaborator

@ChrisHuynh333 ChrisHuynh333 commented May 31, 2024 •
edited
Loading

What does this PR do and why?

This PR updates the Project and Sample docs. This includes:

  • Projects Intro
  • View Project History
  • Samples intro
  • View Samples History
  • Download Sample Files
  • Sample Metadata

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
  1. Read the documentation and see if it makes sense from a user's perspective.
  2. Check that links navigate to the correct pages.

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 ChrisHuynh333 self-assigned this May 31, 2024
@ChrisHuynh333 ChrisHuynh333 changed the title Docs: Add docs - View history, sample metadata Docs: Project and Sample May 31, 2024
@ChrisHuynh333 ChrisHuynh333 marked this pull request as ready for review May 31, 2024 17:22
@ChrisHuynh333 ChrisHuynh333 added the ready for review Pull request is ready for review label May 31, 2024
JeffreyThiessen
JeffreyThiessen requested changes May 31, 2024
View reviewed changes
Copy link
Member

@JeffreyThiessen JeffreyThiessen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Just a couple nitpicks

docs-site/docs/user/organization/members/group-and-project-members.md Show resolved Hide resolved
docs-site/docs/user/organization/members/group-and-project-members.md Show resolved Hide resolved
docs-site/docs/user/project/projects/manage-projects.md Outdated Show resolved Hide resolved
JeffreyThiessen
JeffreyThiessen previously approved these changes Jun 4, 2024
View reviewed changes
Copy link
Member

@JeffreyThiessen JeffreyThiessen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

ericenns
ericenns previously requested changes Jun 13, 2024
View reviewed changes
Copy link
Member

@ericenns ericenns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one minor comment, otherwise it looks great

docs-site/docs/user/project/samples/sample-metadata.md Outdated Show resolved Hide resolved
deepsidhu85
deepsidhu85 requested changes Jun 20, 2024
View reviewed changes
Copy link
Contributor

@deepsidhu85 deepsidhu85 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great just a couple of small comments below

docs-site/docs/user/project/projects/manage-projects.md Show resolved Hide resolved
docs-site/docs/user/project/samples/manage-samples.md Show resolved Hide resolved
JeffreyThiessen
JeffreyThiessen previously approved these changes Jun 20, 2024
View reviewed changes
Copy link
Member

@JeffreyThiessen JeffreyThiessen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@github-actions GitHub Actions
Copy link

Simplecov Report

Covered Threshold
92.45% 90%

@deepsidhu85 deepsidhu85 dismissed ericenns’s stale review June 20, 2024 20:12

Has already been reviewed

@deepsidhu85 deepsidhu85 merged commit 8a3767a into main Jun 20, 2024
3 checks passed
@deepsidhu85 deepsidhu85 deleted the add-misc-docs branch June 20, 2024 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@deepsidhu85 deepsidhu85 deepsidhu85 approved these changes

@ericenns ericenns ericenns left review comments

@JeffreyThiessen JeffreyThiessen JeffreyThiessen left review comments

Assignees

@ChrisHuynh333 ChrisHuynh333

Labels
ready for review Pull request is ready for review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ChrisHuynh333 @ericenns @JeffreyThiessen @deepsidhu85