Updated docs #288
Merged
Updated docs #288
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
tarkatronic
force-pushed
the
updated-docs
branch
from
81b6a37
to
6b422ff
Compare
sushantmimani
requested review from
jmink-godaddy,
rscottbailey and
sushantmimani
rbailey-godaddy
requested changes
Jan 5, 2022
This basically expands the CHANGELOG content from 3.x into a few sets of * What will I see different? * What do I do about it? topics that should get users over the 2-to-3 hump even if they read nothing else.
Co-authored-by: Scott Bailey <72747501+rbailey-godaddy@users.noreply.github.com>
rbailey-godaddy
approved these changes
Jan 5, 2022
Ditto! |
|
Fixes #279 |
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.
This is the beginning of a rework of the documentation for tartufo. It has had many issues for some time now, so I am taking this opportunity to incorporate user feedback and improve the overall structure and content of the documentation.
I am starting this as a draft, to give people a sense of where I am headed. The first swing I am taking is at making the documentation more complete. Next I will work on improving the overall structure, so that we don't have a confusing mess of "Usage" vs "Features" vs "Configuration" (that barely even talks about configuration). And then finally, adding an upgrade guide from v2 -> v3.