Commit Graph

27 Commits

Author SHA1 Message Date
Doug Hellmann 1c7f556d4f rearrange existing documentation to follow the new layout standard
This change moves existing files, updates a few of the cross-references
and paths, and fixes some formatting. It is not meant to be the final
word on how the main page looks or how the other files are organized,
but it gets everything roughly into shape. If the glance team wants to
make changes, please do those as follow-up patches

This change depends on the spec and on a feature of pbr that allows us
to move where the auto-generated class reference documentation ends up
in the tree.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb
Change-Id: I9dde267793a5913acb5b1ec028cfb66bc5189783
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-21 14:15:58 -04:00
chenaidong1 5560848e4c Trivial fix
asertEqual should be assertEqual

Change-Id: I44a21a04321d270d2bc08fb5be18143addb1bc79
2017-05-09 07:49:29 +00:00
Ian Cordasco cca243172e Document the duties of the Release CPL
I've written some documentation around the role and duties of the
release CPL due to the fact that I'm leaving this role, Glance, and the
larger OpenStack community. This should provide context for both new and
old members of the Glance community as to their responsibilities and
what is expected of them. It also passes on some experience-driven
advice as to what to do to ensure a better Glance release for all.

Co-Authored-By: Hemanth Makkapati <hemanth.makkapati@rackspace.com>
Change-Id: I8d580d05668d1560b027736fbc1fb1dd36edbabe
2017-04-11 15:08:23 -05:00
Alexandra Settle 9627e7bb1a [docs] Removing docs from dev ref
1. Deletes man pages
2. Deletes indices section
3. Moves the contributor section up to the top

Change-Id: I6d67e7a40e16468bb7bf4ac742361fb44eec4e28
Implements: blueprint overhaul-glance-docs
2017-02-28 15:01:55 +00:00
Brian Rosmaita 61e9858ac7 Update to "disallowed minor code changes"
Added section about minor typos in comments being disallowed,
following the discussion at the Glance meeting on 3 November.

Change-Id: Ic6c6369895a7095c01c1810358f4355c5cc8f0fa
2017-01-17 14:13:11 +00:00
Jenkins d1939eb86f Merge "change the example URLs in api-ref for Glance" 2016-11-04 10:22:18 +00:00
Jenkins d8461e5528 Merge "Add note to docs on release notes prelude section" 2016-09-23 17:06:03 +00:00
Jin Li af70dc6548 change the example URLs in api-ref for Glance
Change all example urls in api-ref/source to
http://glance.openstack.example.org
and document about this standard URL format

Change-Id: I429c1e256fa3bfdc15adbee129b04ef9c028e82d
Closes-Bug: #1611490
2016-09-22 19:16:13 -07:00
Nikhil Komawar edd5bf9e17 Dev-docs: command in code block for refresh config
TrivialFix

Change-Id: Idb940fd023f3d8d449ba1e35b5a2afdc164722e4
2016-09-07 16:22:32 -04:00
Nikhil Komawar a75ddd4112 Add note to docs on release notes prelude section
This commit adds a note to the developer documentation for adding a note
to the prelude section.

It was mentioned in this change [1] that adding notes to the prelude
section for those that are not significantly important isn't
necessary. So, this commit adds a general notice so the docs about the
same.

[1] https://review.openstack.org/#/c/364586/

Co-Authored-By: Nikhil Komawar <nik.komawar@gmail.com>
Co-Authored-By: Brian Rosmaita <brian.rosmaita@rackspace.com>

Change-Id: I0c507706ec39b5eafcdebfb3e1f57dc56976d9a5
2016-09-06 19:32:28 +00:00
Jenkins 9ca2bcaf53 Merge "Index to generate doc page for refreshing-configs" 2016-08-18 04:52:21 +00:00
Jenkins 201d7d303c Merge "Add example for diff between assert true and equal" 2016-08-16 23:04:17 +00:00
Nikhil Komawar 2590b47874 Index to generate doc page for refreshing-configs
Change I2e3d43e43e00cd2a13b5a0fb794ac6e6d2e24dc2 added doc page for
guidelines refreshing-configs. However, the index was missing in that
commit so the documentation page for the same isn't being generated here
[1]. This commit adds index to generate/publish it.

[1] http://docs.openstack.org/developer/glance/contributing/index.html

Change-Id: I072185e8e6fd65c15947db257a39035511fe8450
2016-08-15 11:41:50 -04:00
Nikhil Komawar 7df813bba4 Add guideline to refresh config files shipped with source
This commit adds documentation to help authors identify the steps they
need to take while updating the config files and thereafter.

This documentation is being added as per question asked on change
I534a0dc2d9f82ab70517cde12bfd40d4f5ae69e2

There is some discussion as to when we will be getting rid of the config
file from the tree on the change
Iee695870aefc9cb6142dbc7400672b335588fcc9

Until we do get rid of the config files from source, we need to document
this process for any further updates to configs.

Change-Id: I2e3d43e43e00cd2a13b5a0fb794ac6e6d2e24dc2
2016-08-12 16:16:42 -04:00
Niall Bunting 269f258e1e Add example for diff between assert true and equal
On a patch someone said it was not clear to them what the difference
was. So I made an example, I thought it may be useful to have this in the
docmentation for future reference, for other people.

Change-Id: I2825d66ebae5681162e4a868b1083bdbe7f0917a
2016-08-12 15:07:42 +00:00
Jenkins f36271e110 Merge "Minor tweak to release note documentation" 2016-07-27 01:41:17 +00:00
Stuart McLaren f9adca0e0c Minor tweak to release note documentation
Make it a little clearer that you need to add the release note to git
before running 'tox -ereleasenotes'.

Change-Id: Ia822be3b4024886072fc08600270297ab6a81cba
2016-07-26 14:25:24 +00:00
Jenkins 06dd32340f Merge "Add LOG.warning to Disallowed minor changes" 2016-07-25 22:04:53 +00:00
Jenkins cc4b523968 Merge "Contribution doc change for spec-lite" 2016-07-22 21:55:09 +00:00
Erno Kuvaja c8ecd9321b Add LOG.warning to Disallowed minor changes
Adds move to LOG.warning to disallowed minor changes page with
explanation.

Change-Id: Ib4ac1175005c8f41e65b56770e14d1a7817df7f0
2016-07-19 16:10:10 +00:00
bria4010 d330e5a490 Update to Glance Contributor's docs
* add mention of Glance contrib guidelines to CONTRIBUTING.rst
* update info about api-ref docs now being in-tree
* add disallowed minor code change doc
  * database scripts, as agreed on at 2016-06-23 meeting
  * non-type-safe changes to tests

Change-Id: I1e997efe72828d99626f5b7f2e2f7c96cae8da98
2016-06-29 18:17:53 -04:00
Niall Bunting 4f61f951fd Add documentation about generating release notes
This adds a section about generating release notes to the glance
documentation. So we can point people there if they need to add
some release notes to their patch.

Change-Id: I5756fcc6ff10cf88a2f3ad679f2e565a3c173a93
2016-06-21 10:02:24 +00:00
Erno Kuvaja 90126a5823 Contribution doc change for spec-lite
Refer to new spec lite process from Newton onwards.

Change-Id: I51b90548ee420891ddd1e1e53edb72cf8492f21b
Depends-On: I5f552cede83e6a204c3e469a08b685f1070daab9
2016-04-21 13:34:44 +01:00
bria4010 8d73de6a83 Add 'Documentation' section to 'Contributing' docs
There have been a bunch of patches proposed lately to generated
config files.  This patch adds a section to the Contribution
guidelines explaining where to make changes for various types of
docs.

Change-Id: Iad971e89f9f1a9d534f6040d9516c5be3efd2926
2016-04-01 11:28:46 -04:00
Tom Cocozzello adfc7e5a3f fix docstring warnings and errors
There are many warnings and errors that occur when the docs are
generated.

Co-Author-By: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
Closes-Bug: 1556818
Change-Id: Ifebeb3904f136a56bd6fe6877220b279a1f98354
2016-03-14 18:40:15 +00:00
wangxiyuan 4c95ff9d16 Remove Indices and tables section
As autodoc has been removed from F release[1], Glance would not support
Indices and tables at this moment.

This patch removed Indices and tables section from doc.

[1]: https://review.openstack.org/#/c/11835/

Change-Id: I0c3ba2939f9b0f5b92787d4b108d54677f86fb41
Closes-bug: #1529383
2015-12-29 09:33:04 +08:00
Flavio Percoco 87fed81ed5 Document contribution guidelines
We currently don't have any in-tree docs documenting what the
contribution guidelines for Glance are. I believe this is super useful,
it's easier to contribute to, and it's also versioned and managed by the
team. Therefore, I've started documenting these guidelines in this
patch.

Change-Id: I483eef9103e6241cb0b60da803484cbe1b866c19
2015-11-26 15:23:58 -03:00