Making WordPress.org

Opened 2 years ago

Closed 16 months ago

#6411 closed enhancement (fixed)

Advanced Administration - New DevHub Handbook

Reported by: milana_cap's profile milana_cap Owned by:
Milestone: Priority: normal
Component: Developer Hub Keywords:
Cc:

Description

During a discussion among Documentation team reps (there's no link, we did it in zoom), @kenshino, @atachibana, @estelaris and @milana_cap, we came up with a solution for unsorted documentation. This documentation currently lives in two places:

This handbook should cover topics that are too advanced for end users (for which they mostly turn to hosting support) but are not necessarily developer's tasks (even though historically developers performed these tasks) such as security, configuration, site maintenance, migration etc

We propose this new handbook to live in DevHub under name "Advanced Administration" and at following URL: https://developer.wordpress.org/advanced-administration/

This handbook will be maintained from the dahsboard so we don't need connected GitHub repository for it. All issues will be reported, discussed, and assigned in Docs Issue Tracker repo (https://github.com/WordPress/Documentation-Issue-Tracker/).

Change History (58)

#1 @milana_cap
2 years ago

  • Component changed from General to Developer Hub

This ticket was mentioned in Slack in #docs by zzap. View the logs.


2 years ago

This ticket was mentioned in Slack in #docs by lucp. View the logs.


2 years ago

#4 @LucP
2 years ago

I'll post it here for completion; I wouldn't mind being team rep for this handbook.

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


2 years ago

#6 @milana_cap
2 years ago

I attended Hosting team meeting where the Hosting team kindly offered their help in creating and managing content for this handbook. We agreed that we'd like this handbook to be generated from its own GitHub repository so the plan is as following:

This ticket was mentioned in Slack in #docs by zzap. View the logs.


2 years ago

This ticket was mentioned in Slack in #hosting-community by zzap. View the logs.


2 years ago

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


2 years ago

This ticket was mentioned in Slack in #hosting-community by jadonn. View the logs.


2 years ago

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


2 years ago

This ticket was mentioned in Slack in #hosting-community by jadonn. View the logs.


2 years ago

This ticket was mentioned in Slack in #hosting-community by crixu. View the logs.


2 years ago

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


23 months ago

This ticket was mentioned in Slack in #hosting-community by amykamala. View the logs.


23 months ago

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


23 months ago

This ticket was mentioned in Slack in #meta by javier. View the logs.


23 months ago

#18 in reply to: ↑ description @netweb
23 months ago

We propose this new handbook to live in DevHub under name "Advanced Administration" and at following URL: https://developer.wordpress.org/advanced-administration/

This handbook will be maintained from the dahsboard so we don't need connected GitHub repository for it. All issues will be reported, discussed, and assigned in Docs Issue Tracker repo (https://github.com/WordPress/Documentation-Issue-Tracker/).

One of the reasons to have a GitHub repository for the pages at https://developer.wordpress.org allows for easier contributions as contributors do not require a user account on https://developer.wordpress.org/wp-admin

Taking a quick look at the current repo, it looks like the above decision may have changed based on seeing the manifest changes being made here https://github.com/zzap/WordPress-Advanced-administration-handbook/blob/main/bin/handbook-manifest.json

If the above has changed, @milana_cap @javiercasares could we update the ticket to make note of that

Happy to help guide or create a patch for the above if this is required

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


23 months ago

This ticket was mentioned in Slack in #hosting-community by amykamala. View the logs.


23 months ago

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


22 months ago

This ticket was mentioned in Slack in #hosting-community by jadonn. View the logs.


22 months ago

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


22 months ago

This ticket was mentioned in Slack in #hosting-community by jadonn. View the logs.


22 months ago

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


22 months ago

#26 @JavierCasares
22 months ago

Hello

About this ticket, some answers / requests / changes (as the project evolves).

The main focus for this project "Advanced Admin Handbook" remains the same:

This handbook should cover topics that are too advanced for end users (for which they mostly turn to hosting support) but are not necessarily developer's tasks (even though historically developers performed these tasks) such as security, configuration, site maintenance, migration, etc.

Proposed this new handbook to live in DevHub under name "Advanced Administration" and at following URL: https://developer.wordpress.org/advanced-administration/

Once the handbook is published, maintenance of it will be shared between Docs and Hosting teams, just as we have Themes handbook being shared between Themes and Docs teams.

There are coming some WordCamp / Contributor Day, and it will be useful if the Repo is in the WordPress organization, not only for control, but also for Activity record.

In the future (when the final "first version" has ended) we will use the "manifest" to sync it to the Site / Pages at developer.wordpress.org.

Regards, Javier.

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


22 months ago

This ticket was mentioned in Slack in #hosting-community by amykamala. View the logs.


22 months ago

This ticket was mentioned in Slack in #hosting-community by crixu. View the logs.


22 months ago

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


21 months ago

This ticket was mentioned in Slack in #hosting-community by amykamala. View the logs.


21 months ago

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


21 months ago

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


21 months ago

#34 follow-up: @JavierCasares
21 months ago

  • Type changed from defect (bug) to enhancement

The first version for this Repo is done
https://github.com/zzap/WordPress-Advanced-administration-handbook

Is it possible to move it into the WordPress org at GitHub so more people can contribute and have track of it?

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


21 months ago

#36 in reply to: ↑ 34 ; follow-up: @milana_cap
20 months ago

Replying to JavierCasares:

The first version for this Repo is done
https://github.com/zzap/WordPress-Advanced-administration-handbook

Is it possible to move it into the WordPress org at GitHub so more people can contribute and have track of it?

@dd32 I don't have access to create repo in WordPress org so can't transfer it from my account. How can we do this?

#37 in reply to: ↑ 36 ; follow-up: @dd32
20 months ago

Replying to milana_cap:

dd32 I don't have access to create repo in WordPress org so can't transfer it from my account. How can we do this?

@milana_cap Either ping me on Slack when we're both around and I'll facilitate it with you, or you can transfer it to my GitHub account (@dd32) and I'll immediately transfer it to the Organisation when accepted. All GitHub redirects will work regardless of which direction you choose.

#38 in reply to: ↑ 37 @milana_cap
20 months ago

Replying to dd32:

@milana_cap Either ping me on Slack when we're both around and I'll facilitate it with you, or you can transfer it to my GitHub account (@dd32) and I'll immediately transfer it to the Organisation when accepted. All GitHub redirects will work regardless of which direction you choose.

I transferred it to you so you can do it when you get the time, it's simpler. Thank you so much 🙌

#39 follow-up: @dd32
20 months ago

@milana_cap Repository has been transferred to https://github.com/WordPress/Advanced-administration-handbook

#40 in reply to: ↑ 39 ; follow-up: @milana_cap
20 months ago

Replying to dd32:

@milana_cap Repository has been transferred to https://github.com/WordPress/Advanced-administration-handbook

Thank you so much.

Is this the right place to ask for access? If so, Documentation and Hosting teams should have maintain access and perhaps admin access for Javier and myself just to avoid bugging meta team for small things that might come up.

#41 in reply to: ↑ 40 ; follow-up: @dd32
20 months ago

Replying to milana_cap:

Is this the right place to ask for access? If so, Documentation and Hosting teams should have maintain access and perhaps admin access for Javier and myself just to avoid bugging meta team for small things that might come up.

Done! I had assigned some of that upon transfer, but seem to have set y'all as read accidentally. Should be fixed now!

This ticket was mentioned in Slack in #hosting-community by crixu. View the logs.


20 months ago

#43 in reply to: ↑ 41 @milana_cap
20 months ago

Replying to dd32:

Done! I had assigned some of that upon transfer, but seem to have set y'all as read accidentally. Should be fixed now!

It is, thank you a bunch ❤️

This ticket was mentioned in Slack in #hosting-community by javier. View the logs.


20 months ago

This ticket was mentioned in Slack in #hosting-community by amykamala. View the logs.


20 months ago

This ticket was mentioned in Slack in #docs by zzap. View the logs.


18 months ago

This ticket was mentioned in Slack in #docs by javier. View the logs.


18 months ago

This ticket was mentioned in Slack in #docs by javier. View the logs.


18 months ago

This ticket was mentioned in Slack in #docs by estelaris. View the logs.


16 months ago

This ticket was mentioned in Slack in #meta by estelaris. View the logs.


16 months ago

#51 follow-up: @milana_cap
16 months ago

Hello @dd32, what can we do to make this handbook public? It is ready from the content perspective and has manifest.js file.

#52 in reply to: ↑ 51 @dd32
16 months ago

Replying to milana_cap:

what can we do to make this handbook public? It is ready from the content perspective

Thanks for the follow up, we were waiting on the content being ready before the handbook could be setup.

There's some work that needs to be done in WordPress.org code now to import it. I'm not 100% on the steps but hopefully it'll be setup when you get this response.

#53 @dd32
16 months ago

In 12504:

Markdown Importers: Jetpack's jetpack_require_lib() helper method no longer exists. Use direct file references.

See #6411.

#54 follow-up: @dd32
16 months ago

Ended up needing to fix a bunch of broken things on the WordPress.org side, and fix the manifest file that was very incorrect.

See https://github.com/WordPress/Advanced-administration-handbook/pull/190 for the changes I made.

#55 in reply to: ↑ 54 @milana_cap
16 months ago

Replying to dd32:

Ended up needing to fix a bunch of broken things on the WordPress.org side, and fix the manifest file that was very incorrect.

See https://github.com/WordPress/Advanced-administration-handbook/pull/190 for the changes I made.

Thank you so much

#56 @dd32
16 months ago

@milana_cap Is there anything else needed here from the Meta side?

#57 @milana_cap
16 months ago

As far as I know, no. Thanks. The ticket can be closed now (I'd do it but I don't know what to resolve it with).

#58 @dd32
16 months ago

  • Resolution set to fixed
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.