Skip to content

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

Merged

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Oct 19, 2022

Refs: #9746


📚 Documentation previews 📚

@benjaoming benjaoming added the Improvement Minor improvement to code label Oct 19, 2022
@benjaoming benjaoming requested a review from a team as a code owner October 19, 2022 15:11
@benjaoming benjaoming force-pushed the diataxis/traffic-analytics-howto branch from cfe17bf to d0ed2c5 Compare October 19, 2022 15:13
@benjaoming benjaoming requested a review from humitos October 21, 2022 15:03
@benjaoming benjaoming marked this pull request as draft November 9, 2022 22:23
@benjaoming benjaoming changed the base branch from main to diataxis/main November 24, 2022 14:33
@benjaoming benjaoming changed the title Docs: Re-label Traffic Analysis as a how-to guide (Diátaxis) Docs: Relabel Traffic Analysis as a how-to guide (Diátaxis) Nov 24, 2022
@benjaoming benjaoming force-pushed the diataxis/traffic-analytics-howto branch from 50d49d6 to d650294 Compare December 9, 2022 19:41
@benjaoming benjaoming marked this pull request as ready for review December 9, 2022 20:16
@benjaoming benjaoming changed the title Docs: Relabel Traffic Analysis as a how-to guide (Diátaxis) Docs: Relabel Traffic Analytics as a how-to guide (Diátaxis) Dec 9, 2022
@benjaoming benjaoming changed the title Docs: Relabel Traffic Analytics as a how-to guide (Diátaxis) Docs: Split Traffic Analytics to a How-to guide and a Feature entry (Diátaxis) Dec 9, 2022
@benjaoming
Copy link
Contributor Author

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.

@humitos
Copy link
Member

humitos commented Dec 12, 2022

@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.

@benjaoming
Copy link
Contributor Author

@humitos the force-push here happened because I merged in main by mistake.

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is close 👍

@benjaoming
Copy link
Contributor Author

re: @ericholscher

I think it's probably better to draft new pages in our feature list for this, but I guess having them here before refactoring them later is OK?

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.

@ericholscher
Copy link
Member

@benjaoming

I thought we explicitly said we're building the features list in the sidebar for now, and then moving it to Reference?

Screenshot 2022-12-12 at 3 09 50 PM

That is what I'm describing, is that analytics "feature" page, which will be under the sidebar Features page for now, but moved to Reference > Features later.

@benjaoming
Copy link
Contributor Author

Ah, I missed that in the task list, thanks 👍

@benjaoming
Copy link
Contributor Author

@ericholscher some new texts added, this is ready for another review.

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@benjaoming benjaoming merged commit d8f5282 into readthedocs:diataxis/main Dec 22, 2022
@benjaoming benjaoming deleted the diataxis/traffic-analytics-howto branch December 22, 2022 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants