When --strict is passed warnings are treated as errors to stop the
build. This is useful for debugging when running tools/test.sh
locally, for example.
Change-Id: I1747f0e554d76ed85d8e00cf850f3413eef1949b
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Do not start the ThreadPool when there are no links to check.
Change-Id: I355ea5af5d937e6b5d4cf481d9a29c6d3b123f09
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
In 0ba83e5 we started trying to ignore unofficial projects and
introduced a bug so that all projects were dropped from the project
list as part of that evaluation. This patch fixes the bug by copying
the valid data from the raw values read in to the list of values being
passed to the template.
Change-Id: I4aeafe6d8116f3b032a5d339660878a76a10e2f3
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Update the template generator to ignore unofficial projects when
rendering for the current series. Ignoring, rather than throwing an
error, allows us to clean up the data without the build breaking.
To make the validation work for glance-store, a new field is needed to
set the 'deliverable-name', since it is different from the project
name used to build URLs.
Change-Id: I0876c93b49d57818d0b689fd03a0171a96e27547
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The two are different use cases, and we have things that focus on the
cloud-wide story. Lead with those, then show docs for individual
services that users can fallback to if they need to.
Update docs and update this for all branches that your the project-data
for language-bindings (pike and queens only).
Change-Id: Ib1f7b7c77ec2b9536c4a03425694a6300025a6c3
Set up the variables the same way the post job is set up:
Pass them in via environment in job definition.
Pass ZUUL_ environment variables through to jobs.
Note ZUUL_REFNAME is not set, use ZUUL_BRANCH instead.
Change-Id: I5863a05384c9a48445d5ce52ccc508519c7c00f8
If jinja template initialization, parsing, rendering, or writing fails,
we used to sometimes log an error message, then sometimes continue
(ignoring the failure), sometimes reraise the exception, and sometimes
fail without raising the exception. With this change, we always raise
the exception so we print the traceback and fail the build right away.
Change-Id: I04a36c4c8c69dbd08e9ea677983dbe00fa3a67a3
Update the page template for the deployment guide list to use the
project-data.
Add data to pike for the existing deployment guides.
Update the latest project-data file for the available deployment
guides for queens.
Change-Id: Idc5923ee8b930c75594d42d91450b25be7ee4594
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Checking http://files.openstack.org/docs/ , we see that
redirect-tests.txt gets published - this is a test file, let's remove it
before publishing.
Change-Id: Id9b2fb0f7d196d53e64296e99ba959c029579b81
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
The security guide is translated into Indonesian, copy the common
translated files over whenever they change.
Change-Id: Ic34b01ac0f706e5649179a8f0b42018c1c5a46fb
These infra repos are publishing at the normal location (/REPO) and not
under /infra/REPO. Add them to our indices and avoid the redirection for
infra repos.
Change-Id: Ib2fa39725746c1b15bee1e2b57c58ff133e4187d
Add a file containing the tests for all of the redirect rules and set
up whereto to run during the check. The test file is a template, just
like the htaccess file, to ensure we auto-generate the rules for all
of the various project redirects.
Fix a few issues with the template generator that ended up producing
duplicate or useless rules.
Change-Id: I0d306149dc33f64d44d9482fab02101bd1f6d7f5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The releases and releasestatus repos end up producing redirects that
conflict with other rules. Since neither has documentation anyway, we
can ignore them when generating the redirect rules.
Change-Id: Ie1e0217685a9d1209b5265112c8fc1ca2a49f5b0
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Rather than looking at the file extension, look at the directory where
the files exist.
Change-Id: I1a2b668a285437478b19c1e965e1efb943f4f598
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
We wrote a library to encompass this data, and it knows a bit more about
how to handle things like placement and whatnot. Use it.
Canonical name for senlin is clustering, use that one to fix build.
Change-Id: I215fb11c1e7e6aac5e020f3f3da3a0a0632cc2eb
This patch marks pike as being "maintained" and creates the queens
landing page templates.
Change-Id: I8efa2706f340e3f6ae7815d0a30e025c5352b555
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
When using www-generator.py with --check-all-links we don't want to
look for links that we do not expect to find or want to use. Limit the
URLs checked by the project type in that case.
Change-Id: I7560ec5d57d564730ebe60957153ea63f58002f8
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Add landing pages with references to all of the historical versions
for completeness. For the versions where we do have guides still
published, include links.
Change-Id: I62211adab1628f10e88f4892dd85a50170da1d96
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Add a variable to hold the title of the series for a given
template. This is set to the name, regardless of whether the series is
the "latest" or not.
Change-Id: I3ca9b19b9e46478107f4c689f85772f15863557a
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Use a ThreadPool to check the links in parallel so the check runs
faster. Results are still reported in order.
Also only get the HEAD and not the whole body of the page.
Change-Id: Ie4fbb97dd3393ac050b36057aee3b939dea58de2
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
No need for build-install-guides-rst.sh, move to build-all-rst.sh.
Simplify build-all-rst.sh since we now do not have versioned or draft
docs anymore.
Change-Id: I213eff811d83ddfb1da3bb15dd8c99adeec93eb9
Standardize on all upper case variable names so it is easy to tell
local variables in a template apart from global variables set by the
generator.
Change-Id: I69a73b580f1b32547287616c768887732553f9c5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Use the list of series names in the template generator to build the
dropdown list of series names so we don't have to update that template
by hand every release cycle.
Change-Id: I8f7950f25cb16b0bc5ffbd8e7d257157432b11f6
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Move the setting for the released and in-development series to the
template generator so that we only have to track that information in
one place.
Change-Id: Ibd66e3ca9dea7451647b8d8289f0f9c11c002477
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Publish changes to this repo directly from the master branch to the
working site. Do not move changes into a "draft" folder before
publishing.
"Docs like code"
Change-Id: Iac54bd70ec587ba27019f5377dcf99a3c9460dcb
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Instead of setting the series for each page within the page by hand,
have the template rendering code derive the value based on the path to
the template.
Change-Id: I366e809b710e5766c6345d817afc2717eff5e0a8
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Use URLs with index.html to explicitly look for content being
published, not just an apache directory listing.
Closes-Bug: #1705250
Change-Id: Iae116ee81210489d9de2a1833d341c3842ac95e5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The ops guide is intended to be moved to the os wiki.
This document can be sourced to migrate in the before-migration
tag in the repo.
Change-Id: I1ca840909438521d0d1da3469f7fa3f2927a6225
TODO: Add landing page detailing the above
If we ran "tox -e publishdocs" locally, there won't be a
publish-docs/www/ directory and we don't want to create one when the
template test script is run. Have it check the existing directories to
derive where it should write its output.
Change-Id: I4ee8495bc0fb8c6a59424332d498956ea7e7e870
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Rather than having a list of pages that needs to be checked and
updated by hand, keep track of the pages we write and pass the list to
the template to render a complete list automatically.
Change-Id: Ia3f5acb4ce850de5f64b66e93409860d4bbf2af7
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Move the rendering logic to its own function so we can reuse it.
Also add a switch to disable URL checking to expedite testing.
Change-Id: I7fe6c56c3c204c3a9080996e2c41b5e18999ded0
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>
Before we add projects to the project list page, ensure that they have
already published documentation for the relevant series.
Change-Id: Ia81a775c95caa1b3a32640abb86c1beb56697d6e
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The useful content in the user guide is all being moved to
project-specific docsets. We can remove the guide here, and replace it
with a /user/ landing page that provides links to all of the known user
guides for services and clients.
Change-Id: I7005b4288b94e755f406fd6a8e3273265b643042
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Add an admin-guide.html page that lists all admin guides for all
projects that have them.
Replace the link to the central admin guide on the main page with a link
to the new templated page.
Add a flag to the project data schema to indicate when a project has an
admin guide.
Update the project data to set the has_admin_guide flag for projects
that already have them published.
Change-Id: I514fe5034c26a42cfb4225d521691c32c0ba9ef4
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Add --check-all-links option to www-generator.py and have it report a
warning for links that do exist for a project but that are not enabled
in the project data file. This can be used to update that data file to
turn on flags and link to additional documentation.
Change-Id: I7941c6fd8ef53c37bd309542d5938699fa6fb475
Signed-off-by: Doug Hellmann <doug@doughellmann.com>