Jump to: navigation, search

Difference between revisions of "Documentation/NewtonDeliverables"

(Contributor Guide)
 
(3 intermediate revisions by 2 users not shown)
Line 16: Line 16:
  
 
==Contributor Guide==
 
==Contributor Guide==
* <s>UI/UX section improvement</s>
+
* <s>UI/UX section improvement</s> http://docs.openstack.org/contributor-guide/user-guidelines.html
* Improve documentation of docs tools/theme etc
+
* Improve documentation of <s>docs tools</s>/theme etc http://docs.openstack.org/contributor-guide/doc-tools.html
* </s>Add diagram recommendations</s>
+
* <s>Add diagram recommendations</s> http://docs.openstack.org/contributor-guide/diagram-guidelines.html
* <s>Document new Install Guide process</s>
+
* <s>Document new Install Guide process</s> http://docs.openstack.org/contributor-guide/project-install-guide.html
* Process discussions: Who should follow this guide? Introduction of a minimal review time? Section about contribution recommendations: what devs should contribute, review expectations of docs, expected turn-around time, etc. How to deprecate/remove docs? Also define which are continuous-release, versioned, etc. https://review.openstack.org/#/c/346575/
+
* <s>Process discussions: Who should follow this guide? Introduction of a minimal review time? Section about contribution recommendations: what devs should contribute, review expectations of docs, expected turn-around time, etc. How to deprecate/remove docs? Also define which are continuous-release, versioned, etc.</s> https://review.openstack.org/#/c/346575/
  
 
==Security Guide==
 
==Security Guide==
Line 45: Line 45:
 
* <s>Create cookiecutter template for project-specific install guides</s>
 
* <s>Create cookiecutter template for project-specific install guides</s>
 
* Config option to mark documents as deprecated (assuming we will work out how to uniformly decide that)
 
* Config option to mark documents as deprecated (assuming we will work out how to uniformly decide that)
* Get off cloudsite, ability to delete properly. Spec: http://specs.openstack.org/openstack-infra/infra-specs/specs/doc-publishing.html
+
* Match guidelines for consistent RST file naming by renaming RST files from underbar to hyphen in openstack-manuals repository.
 +
* Have Infra team get site off Cloud Sites, for HTTPS and the ability to delete properly. Spec: http://specs.openstack.org/openstack-infra/infra-specs/specs/doc-publishing.html

Latest revision as of 13:12, 5 August 2016

Newton Docs Deliverables

Ops and Arch Guides

  • Review content of both guides, and delete anything out of date
  • Review architecture of both guides, and possibly combine
  • Move Ops Guide into openstack-manuals repo
  • Gather content from Ops internal documentation

HA Guide

  • Move HA Guide into openstack-manuals

Installation Tutorial

Contributor Guide

Security Guide

  • Pull printed guide.
  • Updating neutron section

API Docs

User Guides

  • Work with the Ops Guide to check for duplicated content
  • Check for missing content and out of date content - fix links
  • Bring new service projects into the User Guides - esp. projects that have info in dev docs that could be moved into the user guide
  • IA plan - consistency, links, findability plus tables, code snippets, naming conventions (use contributor guide)

Docs Tools/Infra

  • Docbook XML tool removal
  • OpenStackdocstheme work
  • Create cookiecutter template for project-specific install guides
  • Config option to mark documents as deprecated (assuming we will work out how to uniformly decide that)
  • Match guidelines for consistent RST file naming by renaming RST files from underbar to hyphen in openstack-manuals repository.
  • Have Infra team get site off Cloud Sites, for HTTPS and the ability to delete properly. Spec: http://specs.openstack.org/openstack-infra/infra-specs/specs/doc-publishing.html
https://wiki.openstack.org/w/index.php?title=Documentation/NewtonDeliverables&diff=cur&oldid=129107
wiki.openstack.org
crawl=CC-MAIN-2021-39
32086
application/http; msgtype=response
sha1:2HWLHPJYW3VMZKR4CNEPAX425IPFOLKL
<urn:uuid:3baf56e9-b35e-4ae1-9a5a-47fe2d8c7062>
2021-09-26T19:33:26Z
166.78.186.100
text/html
sha1:IR4ANZAXBMWJQFS54KGGTCDVDV4V7INI
<urn:uuid:b7e3c266-3301-4d47-bbfc-399aea61a4f8>
https://wiki.openstack.org/w/index.php?title=Documentation/NewtonDeliverables&diff=cur&oldid=129107
response
<urn:uuid:dbd119b0-93f7-4193-953a-c25f7c622db5>
isPartOf: CC-MAIN-2021-39
publisher: Common Crawl
description: Wide crawl of the web for September 2021
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-43
software: Apache Nutch 1.18 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.2-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/