Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Refactor security logs as reference (Di谩taxis) #9985

Merged

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Feb 3, 2023

This basically just takes the current article and turns it into a howto.

Leaves open a question about how to represent it as a feature.

The how-to can benefit from some screen shots.

Refs: #9746


馃摎 Documentation previews 馃摎

@benjaoming benjaoming added Improvement Minor improvement to code Needed: documentation Documentation is required labels Feb 3, 2023
@benjaoming benjaoming requested review from a team as code owners February 3, 2023 18:03
@benjaoming benjaoming changed the base branch from main to diataxis/main February 3, 2023 18:04
@benjaoming benjaoming removed the request for review from agjohnson February 3, 2023 18:05
@benjaoming benjaoming marked this pull request as draft February 3, 2023 18:59
@benjaoming
Copy link
Contributor Author

Will change this into reference...

@benjaoming benjaoming marked this pull request as ready for review February 3, 2023 19:25
@benjaoming
Copy link
Contributor Author

@ericholscher Let this be a "minimal refactor" attempt, curious to hear if you think we can move ahead here.

@benjaoming
Copy link
Contributor Author

Quick note that the menuselection role looks like this if we get readthedocs/sphinx_rtd_theme#1426 in
image

@ericholscher
Copy link
Member

This basically just takes the current article and turns it into a howto.

This is a feature reference right, not a how to?

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.

Solid refactor 鉂わ笍 -- Knock items off the list!

docs/user/security-log.rst Outdated Show resolved Hide resolved
docs/user/security-log.rst Outdated Show resolved Hide resolved
docs/user/security-log.rst Outdated Show resolved Hide resolved
docs/user/security-log.rst Outdated Show resolved Hide resolved
@benjaoming
Copy link
Contributor Author

This is a feature reference right, not a how to?

Maybe I didn't respond to this in writing: But yes, it has been refactored to a feature reference and the only "how-to" a bit of :menuselection: :)

@benjaoming benjaoming merged commit c0ecea4 into readthedocs:diataxis/main Feb 7, 2023
@benjaoming benjaoming deleted the diataxis/security-log branch February 7, 2023 16:00
@benjaoming benjaoming changed the title Docs: Refactor security logs as howto (Di谩taxis) Docs: Refactor security logs as reference (Di谩taxis) Feb 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: documentation Documentation is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants