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 in the www directory.
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: I4dae852f04b3437179f6769096d47efe8b839c23
I2498f00a6c863d078a70289a655b0aa3958325ed changed the badge shown at
the top of documentation pages which describes the state of the
release of the documentation currently being viewed. However the
unfortunately release-switcher dropdown it introduced into
deprecated_badge.tmpl had the side-effect of affecting the badge.html
which is dynamically included in project documentation by some
Javascript in theme/openstackdocs/layout.html within the
openstackdocstheme repository, and the new release switcher was only
designed to work with openstack-manuals, not with any other projects.
This broke the badge for all releases (www/$RELEASE/badge.html),
excluding www/latest/ which has a hard-coded badge.html. This was
missed during testing because the dynamic inclusion mechanism is
hardcoded to retrieve the badge from https://docs.openstack.org rather
than any local repository.
For a quick fix, reintroduce the old badge template as
www/templates/project_deprecated_badge.tmpl
and change all the per-project badges to use this. Later we can
investigate the possibility of enhancing this per-project badge so
that it provides release-switching functionality like the badge
currently in openstack-manuals.
Change-Id: I53c4b35e31bcdda16ffd50f9a8a26c773c8d3574
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
In order to be fully functional to be consumable from
an external project ( ie docthemes)
- removed from external deprecation badge references to
boostrap css and font awesome css
- removed relative references to js and css and made it
absolutes
Change-Id: I07809ba90a4a7cae996994a856d9d6be9d7a1195
This patch includes the link of TripleO documentation which is a uniq
link, unversioned, which means we'll have to include this link for every
new release.
Inside our doc, we have notes when something is release-specific, that's
how it always worked and we have no plan to change it.
Change-Id: Ic63bdbd2f311bb0b409b857fbc4d33a1b16a15f2
added a new fixed badge indicating the deprecation status of each
release
* obsolete - "No longer supported by the community. For the current release,
CLICK HERE.", #ff0000
* EOL - "No longer supported by the community. For the current release,
CLICK HERE.", #ff0000
* maintained - This has two states. The current release and recent releases.
** Current Release - "This is the current release.", #30739C
** Recent Release - "This is maintained, but NOT the current release. For
the current release, CLICK HERE.", #eaeaea
* Current Release - "This is the current release.", #30739C
* Recent Release - "This is maintained, but NOT the current release. For
the current release, CLICK HERE.", #eaeaea
* development - "This release is currently under development For the
current release, CLICK HERE.", #eaeaea
Change-Id: I67a759440c2e99b33aa925c5e17c11a1b885ac82
These linked to /latest instead of /queens/ or /pike/, fix all
the references.
Note that this is also correct for rocky, our tools use "latest" for the
development version which is rocky. Doing this also for rocky will avoid
copying these over and having wrong links.
Change-Id: I901aaace173721d7351ef31f4f579ae24a679dd8
Based off conversation at the PTG, we agreed it would be
beneficial to ensure the contrib-guide is clearly marked
as the doc contrib guide outside of the title.
This change includes a redirect.
Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
We have no separate user guide for those releases, so refer folks to
the pike guide instead.
Change-Id: If4a77f19c9f099ce5301265f9cc1c8532ba7234a
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Add reduced project-data files for older releases that only include
projects with API reference docs or guides to allow us to copy the API
landing page template from pike.
Change-Id: I143f7986f7c6d730696715b687d4e010a23b5a45
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
We have no separate admin guide for those series, so refer folks to
the pike guide instead.
Change-Id: I7eaab3561ba9fe18a43e876a5fde36293583d0f0
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Instead of hard-coding paths to the css, js, and images directories
let the template generator compute those and pass them to the template
context.
Change-Id: I27a55deeb68136fa826496ec3d0223a303346724
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Replaced Google site search by Swiftype search.
Google updating standard site search and placing
query limit + advertisements. Ultimately, entire
program will be deprecated.
Most expedient change that would meet our needs
(including auto-index) was https://swiftype.com/.
Change-Id: Ife766daec171ed578fb098471edbd497b0891561