Add Notary Project docs assessment#27
Merged
nate-double-u merged 5 commits intomainfrom Aug 6, 2021
Merged
Conversation
celestehorgan
suggested changes
Jul 13, 2021
celestehorgan
left a comment
celestehorgan
left a comment
There was a problem hiding this comment.
Nate - This is a great start! In general I think you need to think about:
- What the purpose of producing a document like this is: because we are limited resource in the CNCF ecosystem, we need to spread our resources carefully, and provide feedback that people can action on who aren't us. As such, when writing documentation like this, understand that the purpose of the document is to give enough information to the project maintainers that they can action without us - and anything we decide to help them with is a bonus!
- Who the intended user of the document is: Much of what you've written are in the form of (what amount to) notes to yourself, but aren't directly useful to someone who isn't you, because you haven't provided enough context for someone else to action on.
I'm concerned that perhaps the original documentation in the template was not robust enough, so let's talking during our 1:1 today about how we can improve that going forward.
nate-double-u
force-pushed
the
26-notary-docs-assessment
branch
3 times, most recently
from
4cac2c1 to
31387de
Compare
Member
Author
|
I'm not yet convinced of the Information Architecture suggestions here. I do think that it will need to be a work in progress with the maintainers, especially as the development is ongoing. |
Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u
force-pushed
the
26-notary-docs-assessment
branch
from
297ddc6 to
d09bf05
Compare
celestehorgan
suggested changes
Aug 4, 2021
celestehorgan
left a comment
celestehorgan
left a comment
There was a problem hiding this comment.
Mostly grammar and lexical issues this time; hopefully easy to resolve!
Comment on lines
+33
to
+43
| | Criteria | 1 | 2 | 3 | 4 | 5 | | ||
| | --- | --- | --- | --- | --- | --- | | ||
| | Information architecture | | ✅ | | | | | ||
| | New user content | ✅ | | | | | | ||
| | Content maintainability | ✅ | | | | | | ||
| | Content creation processes | ✅ | | | | | | ||
|
|
||
| Criteria: | ||
| - 1 = (Is not present or requires significant work) | ||
| - 3 = (is present, but needs work) | ||
| - 5 = (is executed extremely well or no improvement required) | |
There was a problem hiding this comment.
I like the change you made to these tables, btw. Far more readable. Could you upstream this to the template? 😍
Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com> Co-authored-by: Celeste Horgan <celeste@cncf.io>
Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u
changed the title
celestehorgan
approved these changes
Aug 6, 2021
celestehorgan
left a comment
celestehorgan
left a comment
There was a problem hiding this comment.
LGTM!
Please wait on @kapunahelewong to give her final okay before merging, @nate-double-u!
kapunahelewong
approved these changes
Aug 6, 2021
Contributor
kapunahelewong
left a comment
kapunahelewong
left a comment
There was a problem hiding this comment.
Minor suggestions. Otherwise, LGTM!
Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com> Co-authored-by: Kapunahele Wong <kapunahelewong@gmail.com>
Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Notary Project docs assessment
Deploy preview: https://github.com/cncf/techdocs/blob/26-notary-docs-assessment/assessments/0002-notary-project.md
Closes #26
Contributes to #32