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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds QA features to user docs #1784

Merged
merged 19 commits into from
May 15, 2024
Merged

Adds QA features to user docs #1784

merged 19 commits into from
May 15, 2024

Conversation

Shrinks99
Copy link
Member

@Shrinks99 Shrinks99 commented May 4, 2024

Fixes #1695

Changes

  • Adds Crawl Review user docs
  • Adds Quality Assurance section to the Archived Items page

Caveats

We're getting to the point where it might be nice to start including images in some of these... 馃憖

- Updates archived item page with the QA tab
- Adds review page and documents its features
@Shrinks99 Shrinks99 changed the title Adds QA features to docs Adds QA features to user docs May 4, 2024
@Shrinks99 Shrinks99 requested review from tw4l and emma-sg May 7, 2024 01:06
@Shrinks99 Shrinks99 marked this pull request as ready for review May 7, 2024 01:07
Copy link
Member

@emma-sg emma-sg left a comment

Choose a reason for hiding this comment

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

Left a bunch of thoughts & suggestions!

docs/user-guide/archived-items.md Outdated Show resolved Hide resolved
docs/user-guide/archived-items.md Outdated Show resolved Hide resolved
docs/user-guide/archived-items.md Outdated Show resolved Hide resolved
docs/user-guide/archived-items.md Outdated Show resolved Hide resolved
docs/user-guide/review.md Outdated Show resolved Hide resolved
docs/user-guide/review.md Outdated Show resolved Hide resolved
docs/user-guide/review.md Outdated Show resolved Hide resolved
docs/user-guide/review.md Outdated Show resolved Hide resolved
docs/user-guide/review.md Outdated Show resolved Hide resolved
docs/user-guide/review.md Outdated Show resolved Hide resolved
Shrinks99 and others added 9 commits May 13, 2024 16:41
Co-authored-by: Emma Segal-Grossman <hi@emma.cafe>
Co-authored-by: Emma Segal-Grossman <hi@emma.cafe>
Co-authored-by: Emma Segal-Grossman <hi@emma.cafe>
Co-authored-by: Emma Segal-Grossman <hi@emma.cafe>
Co-authored-by: Emma Segal-Grossman <hi@emma.cafe>
Co-authored-by: Emma Segal-Grossman <hi@emma.cafe>
Co-authored-by: Emma Segal-Grossman <hi@emma.cafe>
Co-authored-by: Emma Segal-Grossman <hi@emma.cafe>
Co-authored-by: Emma Segal-Grossman <hi@emma.cafe>
docs/user-guide/review.md Outdated Show resolved Hide resolved
docs/user-guide/review.md Outdated Show resolved Hide resolved
Shrinks99 and others added 5 commits May 15, 2024 13:15
Co-authored-by: sua yoo <sua@webrecorder.org>
Co-authored-by: sua yoo <sua@webrecorder.org>
Co-authored-by: Ilya Kreymer <ikreymer@users.noreply.github.com>
- Removes section count (not relevant)
- Adds a note in the permission levels section about crawl review
Changes some of the language slightly from their comment.
@Shrinks99 Shrinks99 requested review from emma-sg and SuaYoo May 15, 2024 18:24
@Shrinks99
Copy link
Member Author

Thanks for the suggestions! Have applied most of them and made a few edits for the two I didn't apply directly. Should be ready to go?!

Copy link
Contributor

@tw4l tw4l left a comment

Choose a reason for hiding this comment

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

I was waiting til the editing calmed down, but looks great, thanks!

Copy link
Collaborator

@SuaYoo SuaYoo left a comment

Choose a reason for hiding this comment

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

Woohoo!

@Shrinks99 Shrinks99 merged commit 1a668fe into main May 15, 2024
@Shrinks99 Shrinks99 deleted the docs-qa branch May 15, 2024 19:01
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 this pull request may close these issues.

QA: Add User Guide documentation for QA
5 participants