docs: rewrite Whirlwind Tour #13
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
laurieburchell
commented
Jun 6, 2025
laurieburchell
commented
- Changed the structure of the tour to focus around tasks
- Added background info about the data
- Added more explanation of software tools
- General prettification
- Tried to be more consistent with capitalisation, probably introduced a mix of British and American spelling
|
The CI failure is OK, ubuntu 24.04 doesn't have 3.7 and the CI hadn't been run since 24.04 became available. I will fix it in a separate PR. |
wumpus
approved these changes
Jun 7, 2025
README.md
Outdated
| Open up `whirlwind.warc` in your favorite text editor. This is the uncompressed | ||
| version of the file -- normally we always work with these files while they | ||
| are compressed. | ||
| This tutorial was written on Linux and MacOS. We think it should also work on Windows WSL, but raise an issue if you encounter problems. |
There was a problem hiding this comment.
I just made it work in actual Windows, at least the wacky Windows thing that Github uses for CI!
|
|
||
| ## Iterate over warc, wet, wat | ||
| (We also have a [web graph](https://commoncrawl.org/web-graphs) by host and domains, but it is not currently demonstrated in this tour.) |
There was a problem hiding this comment.
I'd suggest adding some nearly-empty sections at the bottom for the things that exist and aren't part of the tour yet. Web graph, host index, index annotations. In each case you can point to a github repo or our website, that's better than nothing.
README.md
Outdated
| Let's start with the cdxj index. | ||
| ### CDX(J) index | ||
|
|
||
| The CDX index files are sorted plain-text files, with each line containing information about a single capture in the WARC. Technically, Common Crawl uses CDXJ index files since the information about each capture is formatted as JSON. We'll use CDX and CDXJ interchangeably in this tour for legacy reasons :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.