General writing guidelines in Documentation Contributor Guide

Bug #1895468 reported by Mayur Patil
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Invalid
Undecided
Unassigned

Bug Description

In my opinion, we should follow either Chicago Manual of Style or Microsoft Style Guide.
It will help us to save a lot of time and improve clarity and correctness of technical documentation. Please let me know your opinions.

This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:

- [ ] This doc is inaccurate in this way: ______
- [X] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.

If you have a troubleshooting or support issue, use the following resources:

 - Ask OpenStack: https://ask.openstack.org
 - The mailing list: https://lists.openstack.org
 - IRC: 'openstack' channel on Freenode

-----------------------------------
Release: on 2020-09-03 15:02:43
SHA: b7e6f5279be5b05bb8e5459d44add04fd093444d
Source: https://opendev.org/openstack/openstack-manuals/src/doc/doc-contrib-guide/source/writing-style/general-writing-guidelines.rst
URL: https://docs.openstack.org/doc-contrib-guide/writing-style/general-writing-guidelines.html

description: updated
Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

This is not a bug report, if you want to change policies, better discuss on the mailing list.

Changed in openstack-manuals:
status: New → Invalid
Revision history for this message
Mayur Patil (ram-nath241089) wrote :

Thanks @Andreas, I'd love to. Can you please point to valid mailing list for this one?

Changed in openstack-manuals:
status: Invalid → In Progress
status: In Progress → Opinion
Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

Please keep this closed, no need for a bug report.

Mailing list is openstack-discuss.

Btw. our guides follow the documented styleguides, changing it is a huge task that I doubt anybody would take on..

Changed in openstack-manuals:
status: Opinion → Invalid
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.