Commit Graph

14 Commits

Author SHA1 Message Date
Zuul 5775bcef47 Merge "Add new feature guidelines documentation" 2024-01-26 04:56:41 +00:00
silvacarloss d1edbdbaec Add new feature guidelines documentation
Includes additional documentation to support contributors while
submitting new changes to Manila.

Change-Id: I7878f226c294c873b5086a6504b507dad574eda7
2024-01-15 16:08:39 -03:00
Goutham Pacha Ravi caaf8fd9ed [Doc] Add a quick and dirty IRC guide
For the benefit of new contributors

Change-Id: Iee749a75615b6c31c3764a4e567382d5d4411e4c
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2023-10-09 17:14:00 -07:00
silvacarloss 281b7dd1cd Add developer reference to share server migration
Updates the developer reference with informations regarding the
share server migration feature implemented during Victoria release.

Change-Id: Ia72cf037d2b7dc9fb9d4f19ce141cc044206d6fc
Partial-bug: #1897903
2021-01-06 08:47:25 -03:00
lijunbo c1912b70f6 Add mod_wsgi configuration samples
Extend docs on running manila API with a web server (Apache, NGINX)
Add samples for mod_wsgi

Partially-implements: blueprint wsgi-web-servers-support

Change-Id: Ic756466e65ffd8b5fc6b8e8fb3eef4b8535b46d6
2020-08-11 21:00:54 +00:00
Victoria Martinez de la Cruz 7a1414977f Add uWSGI configuration samples
Added some samples on uWSGI config and some docs
on how to run manila with uWSGI for contributors.

Partially-implements: blueprint wsgi-web-servers-support

Change-Id: I8e68619b00255197b3d3cf6796c60d1a3a04ff36
2020-08-11 21:00:18 +00:00
Goutham Pacha Ravi cf83f96200 [cycle-goals] Add PTL and contributor quickstart
These documents borrow from the cinder, nova and
ironic guides put together painstakingly by
numerous developers.

Change-Id: Ida3480fd1b9cab8eeb9ad002cce7200d89e01cb6
Story: #2007236
Task: #38535
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2020-04-18 22:29:50 +00:00
Thomas Bechtold b1713e6255 Add PDF documentation build
This commit adds a new tox target to build PDF documentation.
It's a community goal[0] to have PDF docs available.

Also some minor fixes are needed for PDF:
- Only show genindex and search for HTML. Theses elements do not make
sense within PDF documents
- Do not include full config sample files. This will not work and
produces a "Dimension too large" error during the latex run.

[0]
https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Change-Id: I66b8c47d599c97e66c2ca76faa66204d5e7c9c3b
2019-08-27 14:40:04 +02:00
Andreas Jaeger 7916986e64 Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that the location API location /shared-file-system and not
/shared-file-systems.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: I86f50af83be699fa7e0fb064abb20324e2d87b86
2019-07-22 19:15:50 +02:00
Zuul d144bf7593 Merge "[DevRef] Add code review guideline" 2019-01-02 14:52:36 +00:00
Goutham Pacha Ravi dd7a15c0ff [doc] Fix api sections in the contributor doc
Weed out outdated/unnecessary info and add link
to api ref.

Change-Id: Ia45c8ad6e2a697d5b76232e17e4df34539d81c12
2018-12-26 11:56:53 -08:00
Goutham Pacha Ravi 39fe5dc0bc [DevRef] Add code review guideline
Clarify the manila code review guidelines
in the developer docs. This document evolved
as part of the discussions at the Denver PTG [1]
and the manila community meeting on 4th Oct 2018 [2].

[1] https://etherpad.openstack.org/p/manila-ptg-planning-denver-2018
[2] http://eavesdrop.openstack.org/meetings/manila/2018/manila.2018-10-04-15.01.log.txt

Change-Id: I953ac9c1ef641db13a4f0165a7b74e447641a7f4
2018-11-05 16:58:18 -08:00
Tom Barron a149c283d7 doc: move stuff from contributor to admin
As agreed in weekly manila community meetings and at the
Queens PTG, several documents currently presented to contributors
are really of general interest to cloud administrators and should
be presented accordingly.

Move the docs on manila back ends, the feature support mapping,
capabilities and extra specs, and export locations and metatdata
to the admin section.

Change-Id: I6d9dec56890fb3a9bc0539c45c43233517cea048
2017-10-18 15:55:24 -04:00
Tom Barron 90060722a9 doc migration: new directory layout
This patch introduces a new directory layout
in doc/source in conformance with the OpenStack
manuals project migration spec [1], moves the
existing content in manila/doc/source into the
new directories, and adjusts index files accordingly.

This is the first step in the migration process
as outlined in the spec.

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Partial-Bug: #1706181
Needed-By: I7924d94b82e7c8d9716bad7a219fc38c57970773
Depends-On: Ifc80fc56648cef74c85464321d1850e8c68449a0
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: Ieea33262101a1d2459492c1c8aaac5fe042279f6
2017-08-24 09:16:25 -04:00