-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
feat(Docs): Added/updated info about our hero and sidekick #16077
Conversation
Also added info about freshnessValidatedDate
Hi @paperclypse 👋 Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days. Gatsby Cloud will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 20 to 30 minutes). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks for making these updates! Added some comments largely around adding more business/user context.
Co-authored-by: Austin Schaefer <[email protected]>
Co-authored-by: Austin Schaefer <[email protected]>
Co-authored-by: Austin Schaefer <[email protected]>
❌ docs-website-develop deploy preview failedYour build failed. View the build logs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good start and maybe my comments were too weeds-y, but I like to think they're still helpful! I know I'm prone to a little bit of tech writer neuroses ;) Some general feedback:
maybe we should use collapsers here and "chunk" them by decision points. For example:
- Collapser 1: Silly tickets that are non actionable.
- Collapser 2: Quick fixes. Outline what constitutes a quick fix: is it language and syntax in nature only? do we include specific kinds of feedback that need SME confirmation and an edit, in excess of >1 hr? Defining these parameters will make it clearer to make the decision point
- Collapser 3: Backlog. Are we deferring to traffic for the time being, until we're caught up? Maybe these are where the SME confirmation can come in -- good backlog tickets are swarmable, require touching bases with a SME and a quick edit contained to 1 section of a doc. This is bc they're immediately actionable and address our quality goal for accuracy and so on. Maybe we only backlog if a doc has a lot of traffic, >900 views per month (i'd also drop in using
kk go ga
here, and referring to freshnessValidated). - Collapser 4: Close it. This is bigger work for docs with <800 views. Work that would require finding a SME, scheduling an interview, significant rewrites, and rounds of reviews.
These are just ideas for certain "boundaries" that might give clearer guidance. My other last piece of feedback would be re-emphasizing that until stated otherwise, our main goal is make the backlog manageable. Once we get to that place, we will rewrite these boundaries.
Co-authored-by: alexa <[email protected]>
✅ Deploy Preview for docs-website-netlify ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@akristen I love the weeds! Thanks so much getting into it :) |
@akristen Not sure about the collapser thing. I'll keep stewing on it. |
netlify build |
Also added info about freshnessValidatedDate