Commit Graph

31 Commits

Author SHA1 Message Date
Andreas Jaeger c3659ae4e2 Change to OFTC
Update for switch to OFTC.

Change-Id: Id6d19d855f274944abce98703211ebd55ec7dd21
2021-05-26 19:29:34 +02:00
Andreas Jaeger 8de4ff8340 Update infra-manual location
The infra-manual now lives on docs.opendev.org, update links.

New location is: https://docs.opendev.org/opendev/infra-manual/latest

Update footer to point to Contributors guide.

Change-Id: If828ad2c894f5b532b96bb9ef1cc95e0f7c7cb5e
2020-03-21 15:19:46 +01:00
Andreas Jaeger b04c695b2c Cleanup jobs
Follow job rename  in openstack-manuals, remove now unused
checkbuild environment and simplify build-index.sh script
since the same content is build everytime.

Also remove www/www-index.html, we do not use it anymore.

Depends-On: https://review.opendev.org/676956
Change-Id: I00b5afc14fc7872edc1c9db9a0aaa7949b1f1443
2019-08-16 17:00:24 +02:00
Andreas Jaeger f2f69c47ba Cleanup repo
Remove unused content, update README.

Update requirements to what should be needed.

Change-Id: I3acd294314ba05da29611f789d75ed9fc8b21faf
2019-07-24 18:42:15 +02:00
Andreas Jaeger d2e1f23d91 Remove firstapp guides
These guides are dead, remove them completely. This will also remove
the documents from the developer website, so remove all links.

Change-Id: Ifd9a4d8a187962498d6f1133226a77308bc2f5ff
2019-07-17 08:42:50 +00:00
jacky06 67d9a7711b Sync Sphinx requirement
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
2. Update some URLs to latest

Change-Id: I12ab3ba42683f9f75189ab597b9768ae5ec7a3fb
2019-06-18 22:22:06 +08:00
Andreas Jaeger 7a6da6a936 Update for OpenDev
Update URLs for recent OpenDev change.

Change-Id: I0f7e48f054da0eeb12593c5756e5f5f47a577f4f
2019-04-21 16:35:33 +02:00
Zuul c0efcf9f52 Merge "Add 'Release Notes' in README" 2018-10-03 16:03:15 +00:00
Qian Min Chen ee8f4b3155 Correct the wrong link url
Since Queens nenamed from Contributor Guide to Documentation
Contributor Guide to distinguish this document from the new
document aimed at all new OpenStack contributors. So this
patch correct the link. Refer to
https://docs.openstack.org/releasenotes/openstack-manuals/queens

Change-Id: I3c9bc403dfcf4c9b6e3ed410256614415ecfc4dc
2018-08-26 22:43:25 +08:00
Qian Min Chen 3a6d7ad882 Add 'Release Notes' in README
Change-Id: I06f46676842791eefb2b114861dd81650fd2972c
2018-08-18 20:35:56 +08:00
Qian Min Chen e4028f4ea3 Add the missing markup for the hyperlink title in README
Change-Id: I02e7eb5f72389ce996d96efa197e8b93cc5e31c1
2018-08-17 21:59:58 +08:00
Andreas Jaeger d3dd598065 Remove mention of api-ref
The move of api-ref in-repo is done, remove reference from README.rst.

Change-Id: Ic49153cca5058a88ebbba811de275d0aff2fc1d0
2018-04-10 10:30:59 +02:00
Andreas Jaeger 22452dcbd0 Update TC links in README.rst
Update to new location.

Change-Id: I74302074bf95e35e8e70ff52aee4f851ab3eb0cd
2018-04-09 09:28:20 +02:00
Andreas Jaeger 6aac3245c3 Remove obsolete tox targets
With using zuul v3 fully, we can remove some old build targets.

Update README for this as well.

Change-Id: I53b894f9a9e69a8755776b8d4c0cccf7b681efda
2017-10-27 10:54:17 +02:00
Andreas Jaeger 1802d7719c Use https for README.rst
Use https where possible.

Change-Id: I4d685834287ecb55a179ffd4ede739a4ea98730b
2017-01-27 10:41:26 +01:00
Flavio Percoco 46b61d4cbd Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/f85631540f7457a0a49eb0d061697d9c\n'

Change-Id: I3d6c847e0d4657c46ce892db7a460cd1f25b81d2
2016-11-25 14:40:42 +01:00
Andreas Jaeger bb8b09bd7a Drop DocBook support, swagger building
We do not need to build and publish the DocBook XML content anymore,
everything is frozen and in the process of moving to projects. Remove
set up for building of DocBook content.

This leaves the XML files still in tree, we can remove them later.

The DocBook XML gates are still setup, so some tox environments have
been made a noop.

Require openstack-doc-tools 1.0.0 which removes DocBook XML support.

Also, drop swagger building, this is not needed anymore.

Change-Id: I276953013a518a09dabb89bb8f80ef7739b4491b
2016-08-23 13:20:09 +02:00
KATO Tomoyuki 8ab9167d01 Cleanup README
Change-Id: I22ff525c14c1be144097b9deb992b3c0d85b0fa5
2016-07-08 07:32:06 +09:00
Anne Gentle cd5b8e1385 Updates to README for current state
- Remove Maven build info
- Add an indicator that api-ref directory will not accept changes
- Remove API reference mentions

Change-Id: Ieacc5ca3fa8342b4417465e25ff4ae0112083936
2016-06-08 17:10:56 -05:00
Andreas Jaeger 7ecc90966f Use git.openstack.org everywhere
Our official git master is at git.openstack.org, update places
that use github instead.

Change-Id: I03a39dada48adf6e4b4390a352f5e057700a3900
2015-12-29 19:48:05 +01:00
venkatamahesh c03c8ce43f Update the documentation contributor guide link
Change-Id: Ib12b29fbe1b616888e31a30414e9a2126daa45a8
2015-12-13 00:12:00 +05:30
xuan.mingyi 0e22ca8826 Update README.md for repo project
Change-Id: I75fb233d903e03bdfef76f0ec0b4bd48f4bf7a1b
2015-08-18 07:26:23 +00:00
Christian Berendt 8aa6f91440 Document Graphviz as a prerequisite of the firstapp doc
Change-Id: I9881eba5dcf9a5ab35d4e703078b72395a743826
2015-08-07 09:07:00 -05:00
Donovan Jones 980dda76e2 minor updates to README including tox Prerequisites on Ubuntu
Change-Id: Iec9cfa62298b5a9330f9f7de8be7728c69e12008
2015-07-30 10:14:40 -05:00
Mitsuhiro SHIGEMATSU a7888604e1 api-site/README.rst has a non-ascii character
"Build and update API docs" section has a non-ascii (utf-8) character.

Change-Id: Id969423cfa33b11184f28983bc62716c78d57988
Closes-Bug: #1432765
2015-03-17 03:12:58 +09:00
Jeremy Stanley f1c0ed5379 Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: Icbbfca07dc418ede61376a2b07e28979358cf497
2014-12-05 03:30:35 +00:00
Chandan Kumar 960d32ffcd Fixed the command to install maven on Fedora
Change-Id: Ib08cd16bfd0dc1ea5afefbf61b9a43479bf8d7f9
2014-08-23 13:18:51 +05:30
Andreas Jaeger f2629172fc Change comments for developer.o.o
The pages are now published on developer.o.o instead of
api.openstack.org.

Change-Id: I768ee2b5acb94bf709b0c36750609e5b8e57a7bf
2014-05-09 16:43:06 +02:00
Diane Fleming 287bc2c119 Update README.rst
Change-Id: I69ad8a7818244c565df09327fe41018826682e7d
author: diane fleming
2014-04-10 10:21:05 +02:00
Gauvain Pocentek 29c74c3d98 Fix bullet list format in README.rst
Change-Id: I3680bd972a2c3247f1a07c84752ca65ce7a54c7b
2014-02-02 11:16:53 +01:00
Andreas Jaeger fa3cd66e24 Improve README
Rename to README.rst for nicer formatting and add additional
information.

Change-Id: I119248e33258c1d40d222034cb5e06e1bfaec93c
2014-01-05 11:02:48 +01:00