80 Commits

Author SHA1 Message Date
Zuul
34439895e3 Merge "Rename review.openstack.org to review.opendev.org" 2019-09-06 09:11:19 +00:00
pengyuesheng
adb8076094 Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: I95aa4478756873eec5f7480ba3ac0e5e4eea0a43
2019-08-01 10:35:53 +08:00
melissaml
646c92be4f Rename review.openstack.org to review.opendev.org
There are many references to review.openstack.org, and while the
redirect should work, we can also go ahead and fix them.

Change-Id: I12adeeb24252b3c86f22bc56f99a26aeeff2ea4d
2019-05-12 02:23:13 +08:00
whoami-rajat
d75eaff065 Add kuryr-status upgrade check command framework
This adds basic framework for kuryr-status upgrade
check commands. For now it has only "check_placeholder"
check implemented.
Real checks can be added to this tool in the future.

Change-Id: I8af38f087672a390ec8b2b78916315b5a646fcbb
Story: 2003657
Task: 26137
2018-10-23 16:51:51 +05:30
Hangdong Zhang
c845319679 Update the documentation link for doc migration
Change-Id: I14c768761f468549dfdcb7daa70fe86d709d9a25
2017-07-24 16:23:47 +08:00
Jenkins
29360fd226 Merge "Use openstackdocstheme over oslosphinx" 2017-07-04 00:56:19 +00:00
Kirill Zaitsev
9872e6a365 Use openstackdocstheme over oslosphinx
This commit is part of general doc-migration effort. It replaces
oslosphinx with openstackdocstheme and marks docs warnings to be treated
as errors.

Kuryr projects do not seem to have any docs in the openstack-manuals, so
there are no docs we need to pull from that repo.
However being the official project kuryr would benefit from unifying
its docs with the rest of openstack projects as well as using
openstackdocstheme, theme intended for official projects
https://docs.openstack.org/openstackdocstheme/latest/

See https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
and https://etherpad.openstack.org/p/doc-migration-tracking for more
information

Change-Id: I4b854a830268beea0e463a1c75f73e8d523f3bfb
2017-07-03 14:26:43 +03:00
XieYingYun
d4d344566f Add Apache License Content in index.rst
Co-Author: Kien Nguyen <kiennt@vn.fujitsu.com>
Change-Id: I52d738369522cdc0bdcdbffa118acd4a0ec7a147
2017-07-03 11:24:36 +07:00
Darla Ahlert
d379968d79 Delete and move outdated docs
This is one part of the process of organizing the Kuryr docs
across Kuryr, Kuryr-Libnetwork, and Kuryr-Kubernetes. This
commit in particular deletes files that are being moved to
their appropriate directories and one file that is outdated.

Change-Id: I60881c2b22f7b3413e9a2223b818f57eaf2af82d
Depends-On: If0e23ffe10f798d2f9f5b37e1b996bd069715721
2017-02-20 13:36:25 -06:00
Hongbin Lu
4727039006 Update the libnetwork devref
It looks the pool prefix length is wrong. This commit fixed it.

Change-Id: I4c044e7eebd1aed15651213a6f90add210553fd9
2017-02-06 16:32:56 -06:00
Jenkins
4c860226c7 Merge "Links do not point to any document" 2016-12-15 06:51:36 +00:00
Jenkins
ac38fdc0b0 Merge "Fixed Warning while executing 'tox -e docs'" 2016-11-23 10:47:26 +00:00
Darla Ahlert
e830ca4a2a [docs] Libnetwork remote driver missing a step
The Libnetwork Networking Design Docs page currently goes from
step 5 to step 7. This commit changes step 7 to say step 6.

Change-Id: Ic4d37ad0d5127631d04da5bc20af7a389754c8cb
Closes-bug: 1641775
2016-11-21 10:10:24 -06:00
Darla Ahlert
1ca045bc5c [doc] Simple doc fix to add some missing styling
This commit adds a set of stand alone curly brackets into a
code block for more readability.

Closes-Bug: 1641780
Change-Id: I448b684a362c6a0abfc67950ec918d11aa92591d
2016-11-15 09:11:16 -06:00
Janonymous
e039508c2a Links do not point to any document
For now we could safely remove these options,
once we have complete documentation it could be added easily.

Change-Id: I7a7ba6b489e83ec2ab909891541922ba9e6d59f3
Closes-bug: #1625015
2016-11-08 13:52:32 +05:30
pawnesh.kumar
e69b23a29d Fixed Warning while executing 'tox -e docs'
WARNING: unknown document: ../specs/mitaka/kuryr_k8s_integration
TrivialFix

Change-Id: I402e3aeb88970fe7d669f438296ada60c8174b99
2016-11-08 11:45:12 +05:30
Antoni Segura Puimedon
8888c860df
Rephrase "networking basis" in watcher devref
This patch replaces "networking basis" with "basic Neutron constructs"
in doc/source/devref/k8s_api_watcher_design.rst.

Change-Id: I1043adc70b8f9c77f85870cdb0824044db17719c
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
Signed-off-by: Antoni Segura Puimedon <antonisp@celebdor.com>
2016-08-30 17:48:41 +02:00
Jenkins
59d57378b2 Merge "Usage is /Plugin.Active --> /Plugin.Activate" 2016-08-23 07:27:31 +00:00
Omer Anson
9e4fae95ae Fix rst format for nested_containers document
Change-Id: I5e82052287e2f0f084195256988d72e8e03caf77
2016-08-21 17:02:06 +03:00
zhangyanxian
0964509d56 Fix typo in the file
Change-Id: I94151a0d287740b1a8a5560d82a9ffa2804f060c
2016-08-15 07:06:38 +00:00
Jenkins
b75dddbdfc Merge "Update Kuryr dev docs" 2016-08-12 13:56:05 +00:00
qinchunhua
455c72d195 Recover two files permissions
two files permissions were modified, need to be recovered.

Change-Id: I7293b6f262605f3902191b3dbffe6215ba0c87a4
2016-08-02 06:59:05 +00:00
Dongcan Ye
ab4591dcbe Update Kuryr dev docs
Update dev docs followed by [1]. Fix include:
1. external references [2]
2. code block [3]

[1] http://docs.openstack.org/contributor-guide/index.html
[2] http://docs.openstack.org/contributor-guide/rst-conv/references.html
[3] http://docs.openstack.org/contributor-guide/rst-conv/source-code.html

Change-Id: I4bb57948835a4f352995e39ade5f03c2bfa34957
Closes-Bug: #1511221
2016-07-28 13:45:43 +08:00
PanFengyun
de217faa4a Fix typos
1. exmple --> example
2. mutliple --> multiple
3. registerd --> registered
4. endpionts --> endpoints
5. responsibilty --> responsibility

Change-Id: I2b62b483553193819fa7172f37991210f0939f2c
2016-07-20 13:50:05 +08:00
Janonymous
68fdf02e56 Usage is /Plugin.Active --> /Plugin.Activate
Change-Id: I68ea5a498458b3f935e4b1ff478109b00d8c6d82
Link: https://github.com/docker/libnetwork/blob/master/docs/remote.md#handshake
2016-07-12 11:56:44 +05:30
Qinchunhua
d628eb9cda Fix one spelling mistake
Fix the spelling mistakes of "exising" .

Change-Id: Ic6ac03be73766264686685472535bf1f2f666549
2016-07-06 08:50:51 +00:00
Fawad Khaliq
eb5cfcd65a Add vikasc to nested container spec assignees
Change-Id: I0fe1d57f9e8c44d797ee87be14fbdc8bf3ff24f5
2016-06-27 01:47:52 -07:00
vikaschoudhary16
16bfca4ce0 Rename spec directory to newton
Directory name for nested-vm and k8s integeration spec should be renamed
to newton.

Change-Id: Ieeda754bee171b83563432069ddc67d13ac6ba72
Closes-bug: #1595441
2016-06-23 14:15:53 +05:30
Jenkins
c5f5ff2aea Merge "Fix .rst format in kuryr_k8s_integration.rst" 2016-06-23 07:03:02 +00:00
Jenkins
b07bbbf31d Merge "Add the description of the Endpoints" 2016-06-20 15:12:00 +00:00
vikaschoudhary16
0db8c87a70 Fix .rst format in kuryr_k8s_integration.rst
Mainly links has been fixed.

Change-Id: Id07a5b324a818337e9fee2a949bc24e962bf319a
Closes-bug: #1591556
2016-06-16 16:08:00 +05:30
Jenkins
95925f3207 Merge "Eliminate unecessary ", or" in watcher design devref" 2016-06-15 14:43:51 +00:00
Jenkins
7848d89667 Merge "Fix the style of Raven devref" 2016-06-15 14:11:35 +00:00
Jenkins
aa8232512b Merge "Fix typos in the watcher desing devref" 2016-06-15 14:01:57 +00:00
Jenkins
27a7ad686e Merge "Fix style issues in existing-neutron-network spec" 2016-06-15 06:07:58 +00:00
Taku Fukushima
d36aad51f6
Fix typos in the watcher desing devref
This patch fixes typos in doc/source/devref/k8s_api_watcher_design.rst.

Change-Id: Ie1c670f84b0980f22e455a2ee2016513299448c5
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2016-06-15 13:29:56 +09:00
vikaschoudhary16
73c7cde610 Fix style issues in existing-neutron-network spec
1. Heading levels are fixed
2. Wherever lines had scope to include more words and ensuring length
is < 79

Change-Id: I5a78f88fff43b7fb1a7ce04b81172f4105b983e1
2016-06-14 15:02:57 +05:30
Jenkins
bf21ca6d03 Merge "Update index.rst for watcher devref" 2016-06-14 09:30:43 +00:00
Taku Fukushima
c316f2f5d5
Add the description of the Endpoints
This patch adds the description of the Endpoints and how it is
translated. The example of each response in each state is added in
Appendix A as well.

Change-Id: Ibfeb11d9d0079bc2e943b3ff918b660d12adaa84
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2016-06-13 15:37:37 +09:00
Jenkins
5e09448e60 Merge "Move the description of the pool member creation" 2016-06-13 06:17:57 +00:00
vikaschoudhary16
bc5429cbc6 Update index.rst for watcher devref
Change-Id: I6e0ce2c38831040f7705fce030c634f377be3f5a
Closes-bug: #1591529
2016-06-11 21:48:41 +05:30
Taku Fukushima
bdcd788119
Move the description of the pool member creation
This patch moves the description of the pool member creation to the
section for the kube-proxy emulation using the LBaaS.

Change-Id: I7e93f31d02cbb518f3910008c1e8513f37dda302
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2016-06-10 13:00:23 +09:00
Taku Fukushima
83fb434750
Eliminate unecessary ", or" in watcher design devref
This patch eliminates the unnecessary ", or" in the watcher design
documentation.

Change-Id: I87f6dda56c74be64338193e1843f6174a4440d23
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2016-06-10 12:51:03 +09:00
Taku Fukushima
a7cabac3c3
Fix the link to K8s integration doc
This patch fixes the broken link to the K8s integration documentation.

Change-Id: I36b55cc0f073848bda4e4fd9f23a68a391055b4b
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
2016-06-10 12:47:16 +09:00
Taku Fukushima
80d2ca8f11
Fix the style of Raven devref
This patch fixes the following broken style of Raven devref.

* The broken link for "Kubernetes API"
* The broken code-block for the ADDED event of the Pods

Change-Id: Iffa4c4c027aa64893704e7fca3ddaaa16b005653
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
Closes-Bug: #1583972
2016-05-20 17:41:57 +09:00
Taku Fukushima
0b0af3d3e6
Add devref of Raven
This patch adds the devref of Raven, a K8s API watcher component. The
devref contains the abstract of Raven, the design of it, the useful
information for developers.

Change-Id: I8f0e801f81f101a51d62f4b4cc854176e67e75dc
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
Related: blueprint kuryr-k8s-integration
2016-04-21 17:55:54 +09:00
Jenkins
6b07c5d7d0 Merge "Fix wrong example in existing-neutron-network.rst" 2016-04-13 17:41:00 +00:00
Irena Berezovsky
53bde0ae4f Fix warning for docs generation
Change-Id: I5f535f3cc65e5bb6d8dcbaf3f7f5b2155a1a5654
2016-04-06 10:28:20 +03:00
Liping Mao
7b5cce42df Fix wrong example in existing-neutron-network.rst
Change-Id: I9861b457770515831d23cc1506f56834256d9e45
2016-04-05 23:29:52 +08:00
Jenkins
5d687a4d66 Merge "Fix typos in Kuryr files" 2016-04-05 06:10:28 +00:00