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

Update usage docs section on creating web archives #899

Merged
merged 4 commits into from
Apr 15, 2024
Merged

Conversation

tw4l
Copy link
Member

@tw4l tw4l commented Apr 12, 2024

Fixes #898

Description

Updates the Usage documentation on creating web archives to:

  • Drop mention of Webrecorder.io
  • Add ArchiveWeb.page
  • Add Browsertrix and Browsertrix Crawler

Motivation and Context

Naming a service that no longer exists under that name and shares our brand identity is probably confusing to users! So let's fix that.

Types of changes

  • Replay fix (fixes a replay specific issue)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change is a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added or updated tests to cover my changes.
  • All new and existing tests passed.

@tw4l tw4l requested review from ikreymer and Shrinks99 April 12, 2024 13:47
Copy link
Member

@Shrinks99 Shrinks99 left a comment

Choose a reason for hiding this comment

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

Great! Thanks for updating this. We still reference our archiving tools as "Webrecorder" in the PYWB section, might be worth changing that language too?

The core recording functionality in Webrecorder is also part of pywb.

docs/manual/usage.rst Outdated Show resolved Hide resolved
docs/manual/usage.rst Outdated Show resolved Hide resolved
tw4l and others added 3 commits April 12, 2024 16:13
Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics>
Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics>
@tw4l
Copy link
Member Author

tw4l commented Apr 12, 2024

Great! Thanks for updating this. We still reference our archiving tools as "Webrecorder" in the PYWB section, might be worth changing that language to?

The core recording functionality in Webrecorder is also part of pywb.

Nice catch! Changed :)

Copy link
Member

@Shrinks99 Shrinks99 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!

@tw4l tw4l merged commit 5712945 into main Apr 15, 2024
7 of 10 checks passed
@tw4l tw4l deleted the update-usage-docs branch April 15, 2024 14:22
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.

Update docs Usage section on creating web archives
2 participants