Commit Graph

120 Commits

Author SHA1 Message Date
Sean McGinnis 070815c08d Update link to git-review setup
If9244c1819ab38676466d821be0b5104b6852c47 split out the developer docs
and a getting started page. This moved where the git-review installation
instructions were, resulting in the docs-contrib setup docs now going to
a page that no longer had the referenced header.

A separate change also moved the CLA information at some point. Link for
those details is also updated to the current location for CLA
information.

This updates the link to go to the current location for these
instructions.

Change-Id: I63914129b7c1458ba15c374d18250744e5a6c1d8
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2024-02-19 09:26:14 -06:00
Natzcheng d7f0a04826 remove unicode prefix from code
Change-Id: I34c32df7c41afe0412762cc6977e0fb2cbaeb44d
2023-09-27 10:06:37 +08:00
Ghanshyam Mann d27fc60d4f Remove retired training-labs repo
training-labs repo is retired now[1], this
commit removes the reference of it from openstack
manual.

Depends-On: https://review.opendev.org/c/openstack/training-labs/+/817505

[1] http://lists.openstack.org/pipermail/openstack-discuss/2021-October/025586.html

Change-Id: Id5ff713810ab07780dc14048c056341806dfc4c2
2021-11-11 03:02:38 +00:00
eric-chen 5cab55f943 Grammar check and correct the typo.
Change-Id: Ie9dd43d0ca76e8446b874c57ea304809aee7a33b
2021-08-27 12:22:59 +08:00
Zuul 0d788190af Merge "Fix grammar issues" 2020-10-27 10:32:45 +00:00
Qi Zhang f8e373682a Fix grammar issues
Change-Id: I461d715a9c7eb2d757f035925ed62b55f75f5c51
2020-10-26 20:27:58 -07:00
Andreas Jaeger 65cc845e33 Change name of OpenStack Foundation
OpenStack Foundation got renamed to Open Infrastructure Foundation,
follow the rename and update links as well.

Change-Id: I9f0f2cd6ebe53874baa02d07ddf6f2e52611119a
2020-10-22 09:42:35 +02:00
Qi Zhang ed7e2b8b2f Fix grammar errors
Change-Id: Ifa04b63ea30ccbb800ee44fc7d0ef44da80d0101
Closes-Bug: #1900071
2020-10-15 18:31:10 -07:00
Qi Zhang 4dab436165 Fix grammar errors
Change-Id: Ia5e41fec62c4f9c43a4bc4897201064657970241
Closes-Bug: #1899725
2020-10-13 21:15:52 -07:00
Andreas Jaeger d498450576 [doc-contrib] Fix sentence
Fix grammar in sentence.

Change-Id: I8a757da9c0725f88f8bb8bb0cea5d5e3afff82d6
Closes-Bug: #1898799
2020-10-07 09:19:41 +02:00
Andreas Jaeger 509b019fca ask.o.o is dead, remove it
Remove ask.o.o references, replace one place with a link to Stack
Overflow.

ask.o.o is read-only now and unmaintained.

Change-Id: If2967a0d960002cc8fb80e6b40f28e42cebce552
2020-09-10 12:37:02 +02:00
zhaoleilc a2d76fa70f Correct a typo in the document
This patch changes "native English- speakers"
to "native English speakers" at the 8 line
in doc/doc-contrib-guide/source/
non-native-english-speakers.rst

Change-Id: I815204a2b7121e90ac3452bdc32cecf9ecccfa31
2020-06-07 12:15:32 +08:00
Zuul 3db7662936 Merge "Fix pygments style" 2020-05-20 17:10:35 +00:00
gugug 35f75d3bf6 Fix pygments style
New theme of docs (Victoria+) respects pygments_style.
Since we starts using Victoria reqs while being on Ussuri,
this patch ensures proper rendering both in Ussuri and Victoria.

Change-Id: I430184f65f1528dfa15b3e6a7810d062226e70e7
2020-05-20 08:24:18 +08:00
Andreas Jaeger 075cf9aeba Update openstackdocstheme version
Switch to openstackdocstheme 2.2.0 version.

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.

Set openstackdocs_auto_version to not version the documents and
openstackdocs_auto_name to use project as name.

Set openstackdocs_pdf_link to link to PDF files for the two
guides that build PDFs. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Update copyright.

Change-Id: Ibd4844364d78abd135e5b094beba8f17503fab26
2020-05-19 13:58:41 +02:00
Andreas Jaeger 7f7038bca4 Remove setup.py
Those are not needed anymore, remove them.

Change-Id: Ib8ea541c3def4950841851080e40d5723b1b5f06
2020-04-25 22:19:10 +02:00
Andreas Jaeger c67079cd61 Redirect infra-manual
The infra-manual now lives on docs.opendev.org, update links and add a
redirect.

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

For the Contribute footer, point to Contributors Guide.

Depends-On: https://review.opendev.org/713925
Depends-On: https://review.opendev.org/713929
Change-Id: I73e3c07e16fc7ef0157f47ffd510a0cc68cee060
2020-03-21 09:17:24 +01:00
Clark Boylan 474308b848 Link to goaccess report for docs.o.o 404s
We are trying to produce richer reports using Goaccess and this includes
404 reporting. Link to that information.

Change-Id: I2a8bec9468da9f384e4d65ac951c4b18c2459543
2020-03-15 08:46:35 +00:00
Zuul ad2b532e99 Merge "Small cleanups" 2020-02-26 11:15:50 +00:00
Ian Wienand 43ea9a9280 Link to system-config-404-checker job
This is a replacement for the 404 listing removed in
I2d53a4ea281717ba864b8cf699ec503998297f4e.

Change-Id: If26b8b7068242bd613d5efe2937ac6537285d0e0
2020-02-26 15:57:50 +11:00
Andreas Jaeger 48cd6edf98 Small cleanups
With newer openstackdocstheme versions, many settings like
html_last_updated_fmt and latex are setup correctly and don't need to
setup in this repo anymore. We require a new enough version, so remove
the obsolete settings.

This repo now requires python 3, so remove python 2.7.x support.

Update hacking to current version supporting python 3.

Change-Id: I238eefeed275fe8115d0e253ca50d38086934b1e
2020-02-22 17:28:31 +01:00
Ian Wienand d612ac1575 Remove 404 link
We are migrating this server and don't believe this data is that
helpful.  See Iccf24a72cf82592bae8c699f9f857aa54fc74f10.

Remove the link.

Change-Id: I2d53a4ea281717ba864b8cf699ec503998297f4e
2020-02-21 14:24:23 +11:00
Witek Bedyk 33345080d0 Update Sphinx documentation URL
Change-Id: I6cc2cc4cb27f26f2c0fa2fd6e4061dae705ba2ef
2019-09-18 16:49:27 +02:00
Andreas Jaeger 2326598033 [doc-contrib-guide] Remove jsoncheck
jsoncheck was used for the old API guides and is not used anymore,
it is removed now from openstack-doc-tools, so remove it here as well.

Change-Id: I5c659e6c9d83eaf93f42488d0cd068861bd8af40
2019-08-16 17:36:51 +02:00
Andreas Jaeger c1cc9cae1f Cleanup jobs and config
Use promote jobs for all publishing jobs, they work fine.

We don't use checkbuild/checklang anymore, remove it.

Keep checkbuild job until we have renamed training-guides to use the new
job.

Change-Id: I882fd90f07987358cd55e3a04a8f7ad0c746ce80
2019-08-16 16:19:56 +02:00
Andreas Jaeger 33a29b2ffb Update docs for api move
Most content from developer.openstack.org is now on docs.openstack.org,
update documentation for this.

A few links for the main index page and translated documents are not
updated yet, they will be updated once they are moved.

Change-Id: Ic7ff7a78c8b1e1ac2b2fef2398e700a59f84d779
2019-07-23 07:32:54 +00:00
Andreas Jaeger 19db787551 Cleanup after api-quick-start import
Remove extra whitespace, line wrap overlong lines, convert too long
table to list-table, remove all setup.cfg files since we don't need them
anymore.

Change-Id: Icb0dc37c21927ecc6de163ae1b0245aea9b9c202
2019-07-17 11:08:28 +02:00
Andreas Jaeger a95821b542 Import api-quick-start
Import the api-quick-start from api-site repository so that it gets
published on docs.openstack.org.

Change-Id: Ic709ee736dda780fb71048a27158838a5806048e
2019-07-16 16:48:32 +02:00
Andreas Jaeger 323d98336a Fix 404s in repo
Fix links that give 404: Replace with updated versions.

For ha-guide: Just drop the links, the guide has been changed so much
that the sections are completely different.

Change-Id: I428e8c5717fc20db8212621acfaf8728246e8e01
2019-05-13 09:31:51 +00:00
Ian Y. Choi 8640f43a6a Use absolute paths in template on publishdocs
Current relative path resolution on template variables
(TOPDIR, CSSDIR, SCRIPTDIR, IMAGEDIR) cannot be used in css templates
which rendered css files are used on docsthemes.

This patch proposes to purposely use absolute URL paths
for publishdocs environment to prevent from side effects using
relative paths and apply the template variables to the tmpl files
which could not be applied previously by changing www-generator tool.

Also, changes doc-contrib-guide documentation properly.

Change-Id: I3ffda6cc6fa360a09dbcbba2ec924be054a88142
2019-04-25 01:31:48 +09:00
Andreas Jaeger 0b93bc4640 OpenDev changes
The recent OpenDev change changed a few URLs. Redirects are in place but
let's use the new URLs everywhere:

review.openstack.org moved to review.opendev.org, git hosting moved from
git.openstack.org to opendev.org.

Change-Id: I5cbcaed5a7ab0ab7994045a90e1a91e4a43c7611
2019-04-20 14:54:55 +02:00
Andreas Jaeger ff09c2fff0 [doc-contrib-guide] Update set up instruction
The Contributor Guide has a good instruction now on account setup, link
to it and remove outdated instructions.

Remove now unsed graphic.

Change-Id: I840a15e17881cd61ee9496ca5126e96707689576
Closes-Bug: #1820198
2019-03-15 15:40:36 +01:00
Zuul 84df796a1b Merge "Provide dropdown menu which allows switching doc release" 2019-02-19 15:23:45 +00:00
Alexandra Settle 695774e246 Adding a note regarding running bindep per project
As I sadly found out yesterday, new users will have to
run bindep on each individual repo they clone if they wish
to build project documentation. This is obvious to those
who have been working on the project forever, but this was
my first new computer in 5 years and I was pretty stumped -
couldn't work out why I needed liberasure to build swift
docs but here we are.

Change-Id: I27fb8ed862f3c2dfafba5f2d916a8c99fce7ec10
2019-02-14 14:07:12 +00:00
Adam Spiers dbd704f335 Provide dropdown menu which allows switching doc release
Currently deprecation badge headers just point back to the root of
the documentation for the latest stable release, so for example the
badge at the top of

    https://docs.openstack.org/latest/user/index.html

just points to

    https://docs.openstack.org/rocky/

It's useful to be able to quickly jump between different releases of
the same documentation page, but currently this requires hand-editing
URLs or many extra manual hops in the navigation trail.  So
automatically generate the links, but only display them if the link
target exists.

Since the main portal page for each release already had a "More
Releases" dropdown, remove that to avoid two dropdowns on the portal
pages.

Change-Id: I2498f00a6c863d078a70289a655b0aa3958325ed
2019-01-24 00:19:22 +00:00
Zuul 1c604748aa Merge "Address copyright and license header" 2019-01-22 22:34:18 +00:00
chenxing dffd1c8469 Address copyright and license header
Context:

- http://lists.openstack.org/pipermail/legal-discuss/2015-March/date.html
- http://lists.openstack.org/pipermail/openstack-docs/2014-January/subject.html#3644

Change-Id: I115d68b578c2f6c3bc846f39bdeceb8a3af1cd40
Closes-Bug: #1709690
Co-Authored-By: Alexandra Settle <asettle@suse.com>
2019-01-22 22:06:01 +00:00
Zuul 2eeda5ede0 Merge "Add title markups for the hyperlinks" 2019-01-17 20:48:49 +00:00
root 49ca47c32f Add title markups for the hyperlinks
Change-Id: I9c6d5f1c117d809afd6d3960603acf7d8f489595
2019-01-17 15:11:52 +00:00
melissaml 77e116b8f0 fix a typo in doc
serivce --> service

Change-Id: I2cf6180a54d0c93d01ce93bcf5451d9e21fb644d
2018-12-22 22:29:58 +08:00
Andreas Jaeger 6dd7a473ae Arch-design cleanup
The arch-design guide has been removed, remove leftovers from
doc-tools-check-languages.conf and doc-contrib-guide.

Change-Id: Icfd067889d1af57e66faadd9c06e99ebd9fe2178
2018-11-30 21:09:30 -05:00
Andreas Jaeger 60a5098b4b Use openstack-discuss
The new mailing list is open, let's change references
(openstack-dev -> openstack-discuss).

See http://lists.openstack.org/pipermail/openstack-dev/2018-September/134911.html

Change-Id: I8dd367518bec094b25c0403299f2106e3d2b7ea7
2018-11-19 08:38:27 +01:00
Andreas Jaeger f80792b1ce Remove obsolete rstbash and '.. path'
The rst2bash tool used the ".. path" syntax to update files. Since we're
not using rst2bash anymore, remove all of this.

Remove also the rst2bash documentation.

Change-Id: I7195cd3b566e9bac67452ec5174687e734fb53bc
2018-10-16 21:22:52 +02:00
Stephen Finucane f6a3950179 Remove remnants of conditional build infrastructure
We no longer build multiple conditional builds. Remove all the tooling
that enabled this along with references to said tooling.

Change-Id: Iea75f686797ab379c235ddbfb2f881b3f6376814
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2018-09-25 16:07:10 +01:00
Stephen Finucane 2250b193e4 Remove '.. end' comments
These were used by now-dead tooling. We can remove them.

Change-Id: I4b4ef694206249da8b98589b3026f2a2be501ee3
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2018-09-25 16:02:19 +01:00
Sean McGinnis 67bad97c52
Remove ha-guide docs to avoid conflict
The ha-guide repo is being restored and owned by the Operations
Documentation SIG. Until the openstack-manuals content is removed,
patches merged to either repo will overwrite the content of the web
site.

Depends-on: https://review.openstack.org/#/c/603219/

Change-Id: Iabd74139d1d73016563d0cfd30cf8ed6a3e1fc57
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2018-09-19 13:44:26 -05:00
Andreas Jaeger 50470925d1 Fix project-navigator links
The navigator has moved, update links.

Change-Id: Idb6f0dc09d0bea0617fa89ab80fc1fd3b196c6cc
Closes-Bug: #1791447
2018-09-09 08:04:57 +02:00
Zuul a634c6a48e Merge "Add the missing markup for the hyperlink title" 2018-08-22 02:23:32 +00:00
Andreas Jaeger cb4369bee9 Disable badge
All documents are versionless, disable badge for pointing out releases.

Change-Id: Ie0496a947529416d627baae1a27b84b20d070d13
2018-08-21 14:34:15 +02:00
Qian Min Chen dad4683357 Add the missing markup for the hyperlink title
Change-Id: If9cdcfdf4846874ab8197339347d214e8c8d337c
2018-08-18 08:16:52 +08:00