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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial Handbook structure #409

Closed
javiercasares opened this issue Aug 16, 2022 · 7 comments
Closed

Initial Handbook structure #409

javiercasares opened this issue Aug 16, 2022 · 7 comments
Assignees
Labels
advanced administration Issues for Advanced administration Handbook

Comments

@javiercasares
Copy link
Collaborator

There is some need for a structure in the new Advanced Administration Handbook.

As we don't know how the final structure will be, some general big "categories" can be added, and then we can create documentation inside them. Initial idea:

  • Server: information about Server / Hosting / sysadmin documentation.
  • WordPress: information about WordPress configuration (advanced wp-config.php, advanced email, etc.)
  • Plugins: not user / developer documentation
  • Themes: not user / developer documentation
  • Resources: general resources / whatever (not sure yet about this)
  • More Documentation: links to external sites (one page only)

This structure can help with #404.

@javiercasares javiercasares added the advanced administration Issues for Advanced administration Handbook label Aug 16, 2022
@javiercasares javiercasares self-assigned this Aug 16, 2022
@github-actions
Copy link

Heads up @lucprincen @javiercasares - the "advanced administration" label was applied to this issue.

@zzap
Copy link
Member

zzap commented Aug 16, 2022

More Documentation: links to external sites (one page only)

Just to mention that we have External Linking Policy in making and these would need to follow some rules. We still don't have all the rules set but here are things to consider when linking to external resource from wp.org: https://make.wordpress.org/docs/tag/external-linking-policy/

@javiercasares
Copy link
Collaborator Author

Yes, that "More Documentation" or the "Resources" was related to WordPress/Advanced-administration-handbook#170 ;)

@zzap
Copy link
Member

zzap commented Aug 16, 2022

Thank you. Just wanted to be sure we're on the same page :)

@javiercasares
Copy link
Collaborator Author

I created a Doc having a first idea (it's going to change, so no problem changing documents from one section to another...).

https://docs.google.com/document/d/1fVIw3DztzyVY18RDPCGk-kDYTO6gzHtx81o7aitGijo/

@javiercasares
Copy link
Collaborator Author

@javiercasares javiercasares moved this from 📋 Backlog to 🏗 In progress in Advanced administration handbook Sep 4, 2022
@javiercasares javiercasares moved this from 🏗 In progress to 👀 In review in Advanced administration handbook Oct 25, 2022
@thomas-price
Copy link

The suggested initial structure includes:
...
L2 - Security
L2 - Performance / Optimization
L2 - Debugging
...

Could I suggest this structure be aligned more closely to ISO20000, ITIL, ITSM, etc...
...
L2 - Security Management
(HTTPS, SSL, Hardening WordPress, Brute Force, 2FA, WAF, Testing, etc.)
L2 - Continuity Management
(Backup, Recovery, Planning, Testing, etc)
L2 - Capacity Management
(Active Monitoring, Logging, Performance, Optimization, etc.)
...

@javiercasares javiercasares moved this from 👀 In review to ✅ Done in Advanced administration handbook Jan 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
advanced administration Issues for Advanced administration Handbook
Projects
Status: Done
Development

No branches or pull requests

3 participants