32 Commits

Author SHA1 Message Date
Andreas Jaeger
6d37f1da94 Remove non-existing combined api-ref document
The "Combined API Reference" does not exist anymore (since ages), remove
a link to it.

Change-Id: I89e97373f0d6cf1cab2bd470aec7f936ab951e68
2019-07-23 07:33:18 +00:00
Andreas Jaeger
6f0bb482b4 Update api-ref and api-guide location
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
2019-07-22 20:28:00 +02:00
Andreas Jaeger
7785f4d09d Update api-quick-start links
Now that the guide is published to docs.o.o, update the index pages.

Change-Id: Iabd7e889eae5fbcbe1a3d9c898b03fccfbb20500
2019-07-22 09:28:44 +02:00
Adam Spiers
d175b76864 Fix per-project deprecation badges
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
2019-02-21 10:47:40 +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
Sebastian Marcet
961f544a4e Updated External deprecation badge resource
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
2018-08-10 11:24:37 -03:00
Sebastian Marcet
81e6a8ced0 Updated Search widget
Migrated from 3rd party search service swiftype to open source SOLR due to cost increase.

Change-Id: I57a2b56430c9cf088964c3c48a21144127a01e8c
2018-07-20 01:02:52 -03:00
Emilien Macchi
40b7544838 Include TripleO in Deployment guides
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
2018-05-18 17:30:17 +02:00
Zuul
dcf933687c Merge "Added deprecation badge" 2018-03-20 16:36:43 +00:00
Sebastian Marcet
b603d1be80 Added deprecation badge
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
2018-03-07 10:12:22 -03:00
Andreas Jaeger
938e240239 [www] Fix release specific links
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
2018-03-02 09:57:44 +01:00
Frank Kloeker
869eb56933 Add de index page for previous openstack releases
includes mitaka, newton, and ocata

Change-Id: I5b8d4550bf36d4140d522cbbba21095a3d8b7601
2018-01-04 07:07:34 +01:00
Petr Kovar
904d278b72 [www] Link to all built guides for Newton and Ocata
See also: I173ecabeb3aa74a3d2ddc6b4ba898d881dcf752d

Change-Id: Id194f19f29c9a04399257f416b4c0b7629c44871
Implements: blueprint retention-policy
Depends-On: Ia73b6c30db178efda9578ef206fba9c86bc90925
Depends-On: I9a0aea36a25f5cd298a92601a8f6de14476f2e21
2017-12-12 19:01:34 +01:00
Ian Y. Choi
0344753c26 Removes unnecessary spaces on landing pages
Change-Id: I20d4b17da4fba6bd439fc255943bcd3dcf476458
2017-11-17 22:10:50 +00:00
Doug Hellmann
76f7c6cb86 be consistent in calling the install guides "guides"
Drop the use of the term "tutorial"

Change-Id: I514a2353537a9c31839af2003ee181da68ca085d
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-10-02 08:51:27 +00:00
Alexandra Settle
85107272be [contrib-guide] Updating url to doc-contrib-guide
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
2017-09-22 14:57:47 +00:00
Andreas Jaeger
07ccfd9caa [www] Use https for releases.o.o
http://releases.o.o redirects to https, so let's use https to reduce
noise in link checking.

Change-Id: Iaa88218b98413d4c7e254add6c055c4068f44f2a
2017-09-08 17:03:14 +02:00
Doug Hellmann
1ca1404ca1 add special notice for COA exam studiers about admin guide
Change-Id: I933790312fcb07bf173845f190cd8ba87e912a07
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-28 15:16:09 -04:00
Doug Hellmann
9dbac10669 move repetitive content from the index pages to the indexbase template
Change-Id: I85d1cb60f77fdfaaada2c82648b3e29eeeb5fc86
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-25 16:48:59 -04:00
Doug Hellmann
70a7d29aeb use SERIES_INFO to pick up the message to describe the series status
Change-Id: I0297a85c245b0d7711ac49506a74239e403a0838
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-25 16:48:59 -04:00
Doug Hellmann
e7bdd8b3a7 move series dates into generator
Change-Id: If4b7ea23b0a52f863d0770a8b460e07f609a0f25
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-25 16:48:59 -04:00
Doug Hellmann
59c3a9847a update release dates and status on all landing pages
Change-Id: I3c31cf740a386462ccaabd5ea9c72732d5a260ce
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-25 16:48:58 -04:00
Doug Hellmann
cc64854c65 add user landing pages for older releases
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>
2017-07-25 05:06:02 +00:00
Doug Hellmann
fa85f4e462 add api landing pages for older releases
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>
2017-07-24 16:25:45 -04:00
Doug Hellmann
ff1f6eed62 add admin landing pages for older series
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>
2017-07-24 16:25:20 -04:00
Doug Hellmann
0690eb5abd move project-install-guide under /install
Change-Id: I39cabc18e40eee968309b63de3d74e3e828645d9
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-21 11:21:48 -04:00
Doug Hellmann
bfddfc4dc1 move project-deploy-guide.html to /series/deploy
Change-Id: I7b1bbd977cad17a8b1392a499aebb557095a0f40
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-21 11:21:29 -04:00
Doug Hellmann
4017c3e019 let the template generator compute relative paths
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>
2017-07-18 13:52:31 -04:00
Sebastian Marcet
50cf024d31 Update Site Search
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
2017-06-20 15:41:27 -03:00
Andreas Jaeger
f72337be60 [www] Use https
Use https where possible now that docs.o.o and developer.o.o use https.

Change-Id: I1f2f18383765a2c32b729b1d8fe0ce5486b19838
2017-01-27 17:19:25 +01:00
Alexandra Settle
75b81a175e [www] Adding project deploy guides to newton
Change-Id: Ie2c1afca1f073784733c448a9a787134cdf8bcab
2016-11-30 12:31:41 +00:00
KATO Tomoyuki
f0ce07a4c2 Publish Newton release
Change-Id: I88e09b5a3bda88587989655805cb444d7690ac58
2016-10-05 17:31:59 +02:00