Commit Graph

70 Commits

Author SHA1 Message Date
Hervé Beraud 20ed3307d1 Add doc/requirements
We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver [1] for the release team [2][3].
Removed specific doc requirements from test-requirements.txt.

The problem here is that this repos haven't doc/requirements.txt file
and by default in this case zuul will use the test-requirements.txt file
to
pull requirements [4].

This requirements file contains extra requirements like flake8 that
collided with those allowed in our job environment and so the new pip
resolver fails to install these requirements and the job exits in error.

This project meet the conditions leading to the bug.

/!\/!\/!\
Notice that I voluntarily added the doc directory even if no docs
are generated here because zuul will try to pull this requirements from
there first and the contained requirements are needed for reno but AFAIK
the releasenotes dir is ignored by zuul. c.f [4] for further details.
/!\/!\/!\

[1] http://lists.openstack.org/pipermail/release-job-failures/2021-January/001500.html
[2] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019611.html
[3] http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019612.html
[4] https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/ensure-sphinx/tasks/main.yaml#L36

Change-Id: Ib224dfe036543c8ec7fe3074fe4280586d35de97
2021-01-07 13:45:33 +00:00
Andreas Jaeger b04c695b2c Cleanup jobs
Follow job rename  in openstack-manuals, remove now unused
checkbuild environment and simplify build-index.sh script
since the same content is build everytime.

Also remove www/www-index.html, we do not use it anymore.

Depends-On: https://review.opendev.org/676956
Change-Id: I00b5afc14fc7872edc1c9db9a0aaa7949b1f1443
2019-08-16 17:00:24 +02:00
Andreas Jaeger f2f69c47ba Cleanup repo
Remove unused content, update README.

Update requirements to what should be needed.

Change-Id: I3acd294314ba05da29611f789d75ed9fc8b21faf
2019-07-24 18:42:15 +02:00
Andreas Jaeger 57ca6e1317 Remove api-quick-start
The document is now in openstack-manuals, we can remove it here
completely together with the jobs for building it.

Add a redirect to new location.

Depends-On: https://review.opendev.org/671115
Change-Id: Ife74ae2b83bdae1e206b0705faf6f623428a3f1f
2019-07-17 10:43:50 +02:00
Andreas Jaeger d2e1f23d91 Remove firstapp guides
These guides are dead, remove them completely. This will also remove
the documents from the developer website, so remove all links.

Change-Id: Ifd9a4d8a187962498d6f1133226a77308bc2f5ff
2019-07-17 08:42:50 +00:00
Andreas Jaeger e222150abd Switch to python3 in tox.ini
We build everything with python3 now, update tox.ini for this.

Change-Id: I4b03ee2dd201b486ba357cdcde3e0992e107754d
2018-09-30 11:23:45 +02:00
Andreas Jaeger 6aac3245c3 Remove obsolete tox targets
With using zuul v3 fully, we can remove some old build targets.

Update README for this as well.

Change-Id: I53b894f9a9e69a8755776b8d4c0cccf7b681efda
2017-10-27 10:54:17 +02:00
Andreas Jaeger 9d230819a6 Use publish-docs for Zuul v3
With Zuul v2, the publishing happens from publish-docs/api-ref.
Let's simplify our scripts and publish with Zuul v3 from publish-docs
directly.

Add new jobs publishlang and publishbuild for Zuul v3 publishing.
Use existing publishlang-api and publishbuild-api for Zuul v2
publishing.

Remove now obsolete comment from doc-tools-check-languages.conf.

Change-Id: I32b29a34c571882cb4d7c542c543ea726e76a0b5
2017-10-09 22:08:27 +02:00
Andreas Jaeger 9e21e9fa43 Cleanup tox.ini
Remove obsolete section and comments, remove sitepackages usage,
thosewere only needed for the docbook XML code.

Change-Id: Ic9881dde14c4d8ac82f859134b2afc0ab88dc268
2017-10-09 22:08:27 +02:00
Andreas Jaeger 54dd1826d9 Prepare for Zuul v3
As part of migration to zuul v3, replace checkniceness by linters
tox target to use a more "common" target accross OpenStack.

Change-Id: I8a23d017902aee36fc1c415e166c7ba441a1fc34
2017-10-07 19:28:52 +02:00
Andreas Jaeger 8f55071693 Build and publish tr_TR api-quick-start
We have now translations for tr_TR:
Enable in configuration, publish at proper place.

Change-Id: I98c3673d9196bc82ad98f1edd9b0e3078f219f23
2017-09-20 09:02:57 +02:00
Frank Kloeker c1ceeca568 Enables Turkish (tr_TR) build for firstapp
Change-Id: I6c340144706ab619bbd2227f6871a22ae35a8f06
2017-09-19 11:33:11 +02:00
Ian Y. Choi 8d50dbbe11 Enables Indonesian (id) build for firstapp
Change-Id: Idfbb25c5396d513f8c0ec2c65b2071e1e662dc8a
2017-09-18 00:14:26 +00:00
Andreas Jaeger 8fa4937999 Fix typo in tox.ini
The last change had a typo in the job invocation, fix it.
Remove ls, the job output showed the content is available as expected.
Fix also permissions on shell script.

Change-Id: I4ef65188ccdeebf59cc684f2de99c2198c0c3127
2017-09-14 21:24:18 +02:00
Andreas Jaeger a07cffc1d9 Publish translated firstapp guides properly
Wildcards do not work in tox.ini, use a shell script instead to
move the content.

Change-Id: I0bfef7e2e936a67ef2cc9efcd802a6c918305374
2017-09-14 19:49:19 +02:00
Andreas Jaeger 466da88bfb Fix firstapp de publishing
Push the translated de files to the right location for publishing.

Change-Id: I0bba0ce06beb7896d32db5cee92caa4c579f84c2
2017-09-14 17:07:43 +02:00
Andreas Jaeger a16c781f23 Fix de API Quick Start publish
We need to move the translated guides - do this also for German.

Change-Id: I4bd195fd732d358657d938798076f0db26896b49
2017-01-27 12:20:01 +01:00
Andreas Jaeger af914d304a Fix de publishing
Remove old code for de documents from tox.ini that caused publishlang to
fail.

Change-Id: I0f30299b90bfdf7d32bfaf595f4a24366d833e9c
2016-10-10 09:06:42 +02:00
Andreas Jaeger 39ee43b843 Remove obsolete tox environments
Infra setup has been changed, remove now obsolote environments.

Also remove unused doc-tests.conf file, with current openstack-doc-tests
it is obsolete.

Change-Id: I35acc842db62ced0226dd2f27cf57f56a05d6409
2016-08-23 16:52:29 +02:00
Andreas Jaeger bb8b09bd7a Drop DocBook support, swagger building
We do not need to build and publish the DocBook XML content anymore,
everything is frozen and in the process of moving to projects. Remove
set up for building of DocBook content.

This leaves the XML files still in tree, we can remove them later.

The DocBook XML gates are still setup, so some tox environments have
been made a noop.

Require openstack-doc-tools 1.0.0 which removes DocBook XML support.

Also, drop swagger building, this is not needed anymore.

Change-Id: I276953013a518a09dabb89bb8f80ef7739b4491b
2016-08-23 13:20:09 +02:00
Ian Y. Choi 1cb6084d34 [api-quick-start] Include more language builds
Chinese (zh_CN) and Indonesian (id) have progress
enough to generate translated documentations.

Change-Id: Ie09b9999d82470f543db0257e631fe4234cac0ff
Partial-Bug: #1608992
2016-08-03 00:06:59 +09:00
Chung Chih, Hung 7f6e20ae5c Add getting_started tutorial for Gophercloud SDK
Add getting_started tutorial for Gophercloud SDK, code had been tested
on a openstack cloud with neutron.

Change-Id: Ife8bc23671ddff175a5ff424e08893c746d97482
2016-03-04 09:55:17 +08:00
KATO Tomoyuki 84758f1e47 Rename common-rst to common
Change-Id: I2007268dde122edf5437c4905dbb8e9cc3b06529
2016-02-14 18:35:38 +09:00
Anne Gentle d4156fe7f8 Adds build script for Swagger JSON conversion
- This change lets us upload Swagger files for testing and
validating online.

Change-Id: Ifb570e42b29ec8f01889c982b7cd700754a0e5f7
2016-02-05 15:21:33 -05:00
Russell Sim 68b1f1e748 Refresh index to match docs.openstack.org
Added tools/build-index.sh which will build an index.html and copy
needed static files into publish-docs/www

Change-Id: If65a9da675a182f0aab659cb076c3a4aba032b58
2016-01-07 13:47:04 -06:00
Ian Y. Choi ba746b0328 Korean API Quick Start Translations
Setup Korean API Quick Start for building and checking.

Note that it will not be published in docs.openstack.org,
as https://review.openstack.org/#/c/233348/ mentioned.

Change-Id: I03e8d2a1fd379094015748fc28196356462adf5a
2015-10-18 10:37:35 +09:00
Tom Fifield c1f973ad60 Stop deleting draft firstapp docs
We have a number of firstapp documents in a range of SDKs
that are in draft status.

Particularly, for SDKs like shade which have all four of the
conditional sections complete, we would like to issue a call
for testing, leading to their eventual publication.

Having an easily accessible link to give testers is a crucial
part of that process. This patch removes the lines that delete
the draft firstapp docs so they can be found on the draft site.

Change-Id: I0457babc095ab152512751b7cb453dc5c1957282
2015-10-14 23:05:42 +08:00
Andreas Jaeger 5c44dccbab Allow publishlang to run several times
Cleanup directory so that the following commands work. This is needed
for developers invoking the publishlang-api manually.

Change-Id: I87379427305e0da06a9434479fa036368b7af463
2015-10-13 18:08:24 +02:00
Andreas Jaeger 9160bc9aa1 API Quick Start Translations
Setup Japanese API Quick Start for building and checking.
Markup German not anymore as draft.

Do not publish content anymore on docs.openstack.org, our
jobs are going to use publishlang-api to publish on
developer.openstack.org instead.

Change-Id: I67d777a6c271fc8dc1ebe3e75b81a09e7c5c3efb
2015-10-10 09:13:57 +02:00
Andreas Jaeger 0d1a00d9a2 Publish German Quick Start on developer.o.o
Prepare tox.ini for publishing to developer.o.o, this needs changes
in project-config to actually do the work.

Add comments to doc-tools-check-languages to point out special
treatment.

Change-Id: Ic467d8d53944b13e65555d910350547d3ded1a86
2015-10-09 14:31:18 +02:00
Anne Gentle 340abc3b14 Builds to quick-start instead of api-quick-start
- Want to publish to developer.openstack.org/api/quick-start

Change-Id: Ic8772a256db740e1ea7fe9aa536b494a94bd714b
2015-10-08 14:00:13 -05:00
Jenkins ef39aa4e56 Merge "Migrates API quick start one pager to RST" 2015-10-07 22:24:57 +00:00
Anne Gentle 4e986a3c7c Migrates API quick start one pager to RST
- Adds openstack commands

Change-Id: I57780453bd8ee214d10b646e7a989de7e33fa2a9
2015-10-07 15:16:17 -05:00
Andreas Jaeger e128658013 Import generatepot-rst for RST translations
Import tool from openstack-manuals to build RST translations.

Change-Id: I54251b272482af0e61755c138e78039e52a9efa6
Depends-On: I93a6d8ccb8c314c0961b87a239462183712cdd26
2015-10-07 08:25:31 +02:00
Jenkins 64246a22d4 Merge "Always check all files with syntax check" 2015-08-12 20:09:06 +00:00
Andreas Jaeger 8e947e2e17 Always check all files with syntax check
The check-syntax only looks at files itself but if an entity file is
changed that is included by other XML files, we would need to check those as
well. Since this is not done currently and there are many entity files,
let's always check all files for syntax problems.

Change-Id: I34970df274e12a15a485bcd8fc3930651af64d4e
2015-08-12 13:49:00 +02:00
Stefano Maffulli c5fa73302b Adding tutorial for OpenStack Shade library
Fixed also a bunch of English-language to the getting started text

co-authored-by: Diane Fleming

Change-Id: I9318cdefb628a7441a984f7c8f200202b41430dd
2015-08-11 11:35:22 -07:00
Andreas Jaeger 351bf3209b Prepare for translation of common files
Move imported files to common-rst directory so that we can share
translations with openstack-manuals.

Change-Id: I3f9be25579ae16550c32303117702d5500370b41
2015-07-23 19:12:35 +02:00
Tom Fifield 95f1049054 Add support for pkgcloud in firstapp in sec1
This patch adds support for pkgcloud to the First App tutorial
in section one.

The code has been tested on a cloud with nova-network.

Partial-Bug: 1449331

Change-Id: I50e5211b6f6df5c26fdcf6f2b39cc5a8308f787c
2015-07-15 12:46:13 +08:00
Andreas Jaeger 3330718f4b Rework RST building
Use the same shell scripts like openstack-manuals for building of RST
files. This simplifies the tox.ini file and allows easier adding of new
tags.

This now build dotnet, fog, and pkgcloud versions as draft documents and
continues to publish the libcloud version.

Change-Id: Id5deebbb54904a44691104e19ef60f15a14c0f7c
2015-07-12 12:03:17 +02:00
Tom Fifield 5a11f8343c Publish Libcloud version of FirstApp
The Libcloud version of FirstApp is ready to move from draft stage
so it can be widely disseminated to satiate the burning need for this
content that is currently not being addressed. The guide was very well
received during it's packed-room summit sesion.

So far it has received significantly more editing and testing than
other sprint-created documents when they were published. This is thanks
to the work of: Andreas Jaegar, Karen Bradshaw, Diane Fleming, Shilla Saebi,
James Dempsey's users, Jon Proulx, Bruno Lago, Chuck Burkett, Dana Bauer,
and the original authors (at least 2 each section).

Any areas lacking in the guide are well understood and captured in the
bug list:
https://bugs.launchpad.net/openstack-manuals/+bugs?field.tag=firstapp
and there are no major blockers that would prevent listing this guide
on developer.openstack.org.

This patch links the libcloud section of developer.openstack.org to the
guide.

Change-Id: If85bc020cd54e3ca06e5d320024dec9428764641
2015-05-21 01:43:54 +08:00
Andreas Jaeger f58477ef61 FirstApp: Move source directory up, rename top-level dir
For the RST guides, we do not need doc/source, since doc is always
empty. Use source directly.

This syncs the setup used here with openstack-manuals.

Rename top-level from openstack-firstapp to firstapp, there's no need
for the long name in this repo.

Change-Id: If4e11a4f90d580876865348e0d88b92cec4b6659
2015-05-01 17:22:46 +02:00
Andreas Jaeger bafd7ef618 Fix FirstApp Draft Publishing
We copy over the api-ref folder, place content there.

Change-Id: I18a1b390fa8721a025ee1c98ce7e1f47fabb528e
2015-04-25 09:16:22 +02:00
Andreas Jaeger 936aa468c4 Publish FirstApp Guide as draft
Publish FirstApp Guide as draft - for now only the libcloud variant.
Draft location will be
http://developer.openstack.org/draft/openstack-firstapp-libcloud

Change-Id: Icfb29f65025cccc31f8884af4cebadcfa381b742
2015-04-24 19:34:40 +02:00
Andreas Jaeger 7d0c7c290e Add docs target, build as part of checkbuild
Add docs target that lists those firstapp targets that are currently
supported. Adjust .gitignore to ignore all build results.

Change firstapp commands so that we have separate build directories per
variant.

Change-Id: I7c5120b1af2de2c3df8f59fe29678e736368365f
2015-04-23 19:12:10 +02:00
Andreas Jaeger 5b7e98b33f Enable some doc8 tests
Enable doc8 on openstack-firstapp directory
but disable checks for overlong lines.

Change-Id: Ia2b385fc8b2bbd379086b00e6681a599ac5b317f
2015-04-21 09:35:53 +02:00
Sean M. Collins c219133376 Add "Writing your First OpenStack Application" Guide
Written during a book sprint in Taipei, from March 30th 2015
to April 3rd 2015.

Co-Authored-By: Sean M. Collins <sean@coreitpro.com>
Co-Authored-By: Tom Fifield <tom@openstack.org>
Co-Authored-By: James Dempsey <jamesd@catalyst.net.nz>
Co-Authored-By: Nick Chase <nchase@mirantis.com>
Co-Authored-By: Christian Berendt <berendt@b1-systems.de>

Implements blueprint openstack-firstapp

Change-Id: I55ae32d0c04f641c818bda4714d9bc691a98e6b1
2015-04-21 09:15:26 +10:00
Sean M. Collins 34d73033b1 Specify the version of Python
Not all systems have a binary named "python2"

Related-Change: Ie498dca57cf262c8b3e61e210e2f89c6a7d5e0fb

Change-Id: If6602979e78d478363a6637390abf95badccfc86
2015-04-14 15:03:20 -04:00
Gauvain Pocentek 40d76e2ca5 Make sure that tox uses python2 by default
Our documentation tools are not python3 compatible, so make sure that
tox creates python2 virtual environments during tests.

Change-Id: I5dca3a92773ffb499c7ba693e2b010cd8e19e8e2
2014-10-31 08:40:25 +01:00
Andreas Jaeger 4b9e370d8d Use doc-tools-check-languages
Use new global language checking script and remove test-languages.sh.

Change-Id: Id954d5b471ba231c85139e7df5d89a478226dc8d
2014-08-18 20:55:46 +02:00