Commit Graph

26 Commits

Author SHA1 Message Date
Vsevolod Fedorov 53bdf1ee7a Update documentation links
Apply URL redirections reported by tox docs-linkcheck output.

Change-Id: Id2f400414068c26d3103ca8fa564b7e9827f9f79
2023-11-09 12:24:34 +03:00
Vsevolod Fedorov f4d64f9f66 Move tests to pytest
Pytest makes each scenario into individual selectable test.
To be able to run each scenario separately is very useful for development.

Change-Id: I4b1c990a1fd839ce327cd7faa27159a9b9632fed
2022-12-20 10:44:43 +03:00
Eric Ball ca4ffdbb35
Fix!: Remove support for EOL python versions
Signed-off-by: Eric Ball <eball@linuxfoundation.org>
Change-Id: I42660519c1cbe94a4322767b1940e113b0e5a276
2022-04-11 10:00:41 -07:00
Thanh Ha 0ee4851331
Update IRC network to OFTC
OpenStack has moved IRC networks to OFTC. Update our docs to
reflect the new location.

Change-Id: I21cfb3d8c069b9c1b44a8e636ee43433305692b8
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
2021-06-01 16:21:09 -04:00
Thanh Ha 197226c538
Fix links causing redirects
Some links have been permanently redirected to a new URL so
adjust the links to go directly to the new URL.

Change-Id: I900091f8bdc39aa5fd06eae04a9b18ef23add8f2
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
2020-01-22 18:23:25 -05:00
Andreas Jaeger 55d54f69bc Update homepage
Since change I5cbf7b5cfea349a0bd72d2abee40710175cf5b2f, this repo
publishes to https://jenkins-job-builder.readthedocs.io/en/latest/ ,
let's update the links for this.

Change-Id: I08f8dd992ee1b6360f3d226cb668cda7f4242b8a
2019-12-22 17:44:46 +01:00
Thomas Bechtold c56e325217 Fix repository location in README.rst
It's nowadays opendev.org so use that.

Change-Id: I91382e8d18deec6c91e84d9232f013792631e66a
2019-11-05 09:29:26 +01:00
Sorin Sbarnea 4953756c27
adopt pre-commit hooks
Change-Id: I98bc0b5717c3921b35e74f53c55f896427880a84
Signed-off-by: Sorin Sbarnea <ssbarnea@redhat.com>
2018-07-12 13:40:38 +01:00
Ken Dreyer fae9868905 README: add mailing list and IRC details
Point users to the mailing list and IRC channel.

Change-Id: Ieb0de98986bb736899620d5052c0528eeea6c788
2018-05-21 09:54:45 -06:00
Darragh Bailey e165b78546 Add comment about proxy env pass through
For users in a proxy environment, checking the doc urls requires being
able to pass through the proxy environment variables. Include a simple
comment along with the tox command requiring it to help users checking
any links added are valid.

Add some references to documentation, both in the detailed
documentation and the quick README.rst that would be more commonly
checked.

Change-Id: I2316bc1b7e845c29a8b248eef4668a6099d109f7
2016-09-15 11:33:35 +01:00
Terry Howe aa41127ef7 Change documentation to install from pypi
Change-Id: I46fe46d0af14563b2e87492c2abe1b39ec246714
2016-04-23 12:20:44 +00:00
Darragh Bailey a6d021ab4f Update Urls for redirects and broken
Update Urls broken in the documentation and code to results of
redirects or where the correct endpoint is known.

Change-Id: Ie4ef2d1e207c7a98295625ed2cb74ab37e85730d
(cherry picked from commit 63ca017d0a)
2016-04-22 15:11:47 +01:00
Khai Do e52bb31fa1 Document that jjb supports json job definitions
Add documentation to let users know that they can also define jobs
in JSON.  Create a new test suite to verify that jjb can correctly
generate jenkins xml from json definitions.

Change-Id: Idb5216b0b56837d0f4dd2298986149be66bd217e
2015-07-28 17:20:29 -07:00
Jeremy Stanley 892a4de53b Replace ci.o.o links with docs.o.o/infra
The http://ci.openstack.org/ documentation site has been deprecated,
replaced by redirects to corresponding paths within
http://docs.openstack.org/infra/ where other Project Infrastructure
documentation already resides.

Change-Id: Iafe263b9e4dddd25358f74edda03eb72781890b2
2015-05-28 06:28:47 +00:00
Darragh Bailey 302255ac60 Check external documentation links are valid
Use sphinx's linkcheck builder to validate any external links.

Fix the broken links by converting the example link to a code segment
and correcting the link referencing the cgit mirror for the git clone
instructions.

Change-Id: Ic6236e250b7af5c7c000af1e67fb69dd720ad6d8
2015-02-24 21:36:54 +00:00
Darragh Bailey 89f266d9a2 Fix formatting for inclusion of README.rst
The contents of README.rst are included directly into the documentation
index file, as a result we need to alter the formatting to align with
the existing contents.

Change-Id: I4e5720790e277377638001c1feddf5779e07238b
2015-02-04 12:55:53 +00:00
Khai Do 0b2db405e4 Update and clean up docs
* Reference the readme.rst in index.rst to remove redundancy
* General cleanup and updates

Change-Id: I64e149087783e67d22fd0f2006accee2a1757ae0
2015-01-23 10:02:43 -08:00
Khai Do 104244b833 update jjb info for clarity
Change-Id: Ic6482bd68ecb3303074979e7ac6686ab50531453
2014-12-28 07:24:54 -08:00
Jeremy Stanley 7e941d599b Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: Id5ff46fc0f3747ecde3404b448557a2b3932ce6d
2014-12-05 03:30:42 +00:00
Michael Krotscheck ca19ad9beb Switched documentation to point to storyboard.
We've migrated this project to storyboard, I'm updating the documentation links.

Change-Id: I10ac8b46e7e905c3f75fed9057d68966afc2d888
2014-11-11 15:19:09 -08:00
Jenkins b92103607f Merge "README.rst: Add links" 2014-04-22 20:20:26 +00:00
Marc Abramowitz 3beff4d255 README.rst: Note GitHub PRs are auto-closed
This makes it a little bit clearer that GitHub pull requests are not
accepted and will be automatically closed.

This is a small tweak to help with one of the issues mentioned here:

http://www.alexconrad.org/2014/04/the-painful-process-of-submitting-your.html

Change-Id: Ie4aa8297a75f00ddd9e6c0fce722aa7a6586d52d
2014-04-19 20:28:54 -07:00
Marc Abramowitz 288938ab72 README.rst: Add links
Change-Id: Ia784781c9142f7a9deaeef812c6c95a936342f3a
2014-04-19 08:48:53 -07:00
Marc Abramowitz 266f1ed054 README.rst: Remove space before bullets
Causes rendering as block quote.

See:

- http://docutils.sourceforge.net/docs/user/rst/quickref.html#bullet-lists
- http://docutils.sourceforge.net/docs/user/rst/quickref.html#block-quotes

Change-Id: I252d3f19286b11403abbe12faaf11db68b175604
2014-04-07 14:41:32 -07:00
Jeremy Stanley e3a72b3034 Update README for project move.
* README.rst: Correct clone URL.

Change-Id: I830e3bfbca6c537dce78449110b1c6d444a0574b
Reviewed-on: https://review.openstack.org/18199
Approved: James E. Blair <corvus@inaugust.com>
Reviewed-by: James E. Blair <corvus@inaugust.com>
Tested-by: Jenkins
2012-12-16 20:27:42 +00:00
Paul Belanger 329633da6d Convert our README to ReStructuredText
This should make pypi.python.org happier!

Change-Id: I2e82bf8cb81545831bdb864b049d01e3faffabb9
Signed-off-by: Paul Belanger <paul.belanger@polybeacon.com>
Reviewed-on: https://review.openstack.org/16486
Reviewed-by: James E. Blair <corvus@inaugust.com>
Approved: Clark Boylan <clark.boylan@gmail.com>
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Tested-by: Jenkins
2012-11-20 17:38:01 +00:00