-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Docs: Split Traffic Analytics to a How-to guide and a Feature entry (Diátaxis) #9677
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
Docs: Split Traffic Analytics to a How-to guide and a Feature entry (Diátaxis) #9677
Conversation
cfe17bf
to
d0ed2c5
Compare
…loper's and designer's guides
Co-authored-by: Eric Holscher <[email protected]>
50d49d6
to
d650294
Compare
I think this fits quite well into the "Main Features" page which is the target of a later refinement. So by adding the feature here, we can ensure that it's duly processed in a later iteration. |
@benjaoming can we avoid using force-push? In particular, after getting reviews from PRs. Otherwise, it resets my review and forces me to see all the differences again instead of keeping the files already reviewed collapsed and showing only the new differences since my last view. |
@humitos the force-push here happened because I merged in |
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 close 👍
re: @ericholscher
I need a bit more guidance here. What sort of feature page do you mean? How should it be included in the navigation? The strategy for the 4 iterations has been to convert feature pages into explanation. We have talked about a structure for documenting features through some kind of pattern, but this was left out. |
I thought we explicitly said we're building the features list in the sidebar for now, and then moving it to Reference? That is what I'm describing, is that analytics "feature" page, which will be under the sidebar |
Ah, I missed that in the task list, thanks 👍 |
…g into diataxis/traffic-analytics-howto
…g into diataxis/traffic-analytics-howto
Co-authored-by: Eric Holscher <[email protected]>
@ericholscher some new texts added, this is ready for another review. |
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 great!
Co-authored-by: Eric Holscher <[email protected]>
…g into diataxis/traffic-analytics-howto
…ing/readthedocs.org into diataxis/traffic-analytics-howto
Refs: #9746
📚 Documentation previews 📚
docs
): https://docs--9677.org.readthedocs.build/en/9677/dev
): https://dev--9677.org.readthedocs.build/en/9677/