Refactor docs to be more approachable #130
Merged
Conversation
This file contains 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
* Move Dataset reference to their own section
* Remove duplicate links (Fixes #103)
* Merge Data Privacy and Data Collection documents
* Move some Cookbooks out from the Tools section
* Clean up READMEs
* Convert straggling .adoc files to .md
* Move "Reporting a problem" to it's own article for visibility * Reflect structure changes made in previous commit
harterrt
changed the title
|
See commit messages for an enumeration of the changes. This is part of a larger annual review of the Documentation. |
mreid-moz
reviewed
May 7, 2018
concepts/reporting_a_problem.md
Outdated
|
|
||
| ### Problems with the data | ||
|
|
||
| There are bugzilla components for several of core [datasets](datasets/README.adoc) |
There was a problem hiding this comment.
Should link to datasets/reference.md
concepts/reporting_a_problem.md
Outdated
|
|
||
| ### Problems with tools | ||
|
|
||
| There are bugzilla components for several of the [tools](tools/README.adoc) that |
There was a problem hiding this comment.
should link to tools/README.md (or maybe better tools/interfaces.md)
introduction.md
Outdated
|
|
||
| ### [Cookbooks & Tutorials](cookbooks/README.md) | ||
| This section contains tutorials presented in a simple problem/solution format. | ||
|
|
||
| ### [Data Collection and Datasets](datasets/README.adoc) |
There was a problem hiding this comment.
Should link to datasets/reference.md
| To run the spell checker locally, [install the `markdown-spellcheck` library](https://www.npmjs.com/package/markdown-spellcheck), then run the following command from the root of the repository: | ||
| To run the spell checker locally, | ||
| [install the `markdown-spellcheck` library](https://www.npmjs.com/package/markdown-spellcheck), | ||
| then run the `scripts/spell_check.sh` script from the root of the repository. |
There was a problem hiding this comment.
+1 moving this command into a separate script!
.spelling
Outdated
| @@ -108,6 +108,7 @@ pushlog | |||
| PySpark | |||
| RDBMS | |||
| RDD | |||
| realtime | |||
There was a problem hiding this comment.
This addition is not needed (spell check passes without it, and the prose uses "real-time").
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.
No description provided.