Page MenuHomePhabricator
Create Task
Maniphest T208944

CloudVPS: admin documentation
Closed, DuplicatePublic
Actions

Description

this task is about consensus on CloudVPS admin documentation, i.e, documentation for us the WMCS team and volunteers contributing to manage the Cloud VPS infra.
We should agree on some points before moving forward in order to have coherence and have all the people on the same track.

This is what we have right now:

  • Most of the relevant admin docs are collected in this page: https://wikitech.wikimedia.org/wiki/Portal:Cloud_VPS/Admin
    • then we have 2 options: the Help:* namespace or the /Admin/* subpage, with documents in both places.
  • We seem to have several types of documents, but the distinction is not explicit:
  • There are documents which are fairly old, obsolete. I added warnings at the top to several of them, but we really need to clean them up or mark them more boldly so there is less noise when searching for docs.
  • Now that we have several openstack deployments in some cases is not clear which doc applies to which deployment because docs aren't explicit about this.
  • Documents don't have a common pattern, layout or scheme for organizing information.
  • Some docs could be merged together, or make the difference between them more explicit, because they are very similar. Not sure how to handle this, because
  • we lack a common organization layout for our docs. Or at least, I feel the lack of it, and I'm forced to make organization choices every time I try to write a doc.

This is my proposal:

  • let's agree on a pattern and organization for our admin documentation. We could create a wikitech page to consolidate our agreements, and do our best to follow it.
  • let's review all the documents, merge and refresh them. My proposal is to check each item in this list once we are happy with it (or it has been deleted, merged, or no other actions required).

Here is a list of current links in the main admin landing page.

Related Objects

Event Timeline

aborrero created this task.Nov 7 2018, 12:04 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptNov 7 2018, 12:04 PM
aborrero moved this task from Inbox to Needs discussion on the cloud-services-team (Kanban) board.Nov 7 2018, 12:04 PM
aborrero mentioned this in T208916: cloudvps: neutron issue with split brain.Nov 7 2018, 12:40 PM
Paladox subscribed.Nov 7 2018, 1:14 PM
aborrero triaged this task as Medium priority.Nov 12 2018, 4:14 PM
aborrero claimed this task.Nov 13 2018, 4:49 PM
aborrero moved this task from Needs discussion to Graveyard on the cloud-services-team (Kanban) board.
aborrero mentioned this in T206706: Establish documentation review process for WMCS.Feb 11 2019, 11:38 AM
• GTirloni unsubscribed.Mar 21 2019, 9:10 PM
aborrero reassigned this task from aborrero to • srodlund.Sep 26 2019, 9:35 AM

@srodlund you might want to take over this ticket: merge it, close it or whatever.

• srodlund added a project: User-srodlund.Jun 25 2020, 8:26 PM
• srodlund closed this task as a duplicate of T211643: Update and Improve: https://wikitech.wikimedia.org/wiki/Portal:Toolforge/Admin .Jun 26 2020, 10:20 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL