https://github.com/openstack/api-site
OpenStack API site. Mirror of code maintained at opendev.org.
https://github.com/openstack/api-site
Last synced: 2 months ago
JSON representation
OpenStack API site. Mirror of code maintained at opendev.org.
- Host: GitHub
- URL: https://github.com/openstack/api-site
- Owner: openstack
- License: apache-2.0
- Created: 2012-09-25T20:14:05.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-11-22T18:32:58.000Z (7 months ago)
- Last Synced: 2025-03-28T12:04:55.776Z (2 months ago)
- Language: CSS
- Homepage: https://opendev.org/openstack/api-site
- Size: 27.4 MB
- Stars: 79
- Watchers: 19
- Forks: 52
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
========================
Team and repository tags
========================
API-Site repository
+++++++++++++++++++
This repository contains the index page for
https://developer.openstack.org in the ``www`` directory.
To complete code reviews in this repository, use the standard
OpenStack Gerrit `workflow `_.
For details, see `Gerrit Workflow
`_.
This repository is in a frozen state, it will be fully retired once a
new home is found for the index page.
Prerequisites
=============
To build the documentation locally, you must install Python and
`Python Tox `_.
To install Tox and dependencies for Ubuntu 22.04 or later::
apt-get install python3-tox python3-dev libxml2-dev libxslt1-dev
To build all the documentation after installing Python and Tox::
tox -e docs
To build an individual document, such as the API Guide::
tox -e api-quick-start
The locally-built output files are found in a ``publish-docs`` directory.
Run tests
=========
To use the same tests that are used as part of our Jenkins gating jobs,
install the Python tox package and run ``tox`` from the top-level directory.
To run individual tests:
* ``tox -e publishdocs`` - Builds all of the documents in this repository,
this is called from CI jobs.
Contribute
==========
Our community welcomes everyone who is interested in open source cloud
computing and encourages you to join the
`OpenStack Foundation `_.
The best way to get involved with the community is to talk with others online
or at a meetup and offer contributions through our processes, the
`OpenStack wiki `_, blogs,
or on IRC at ``#openstack`` on ``irc.oftc.net``.
We welcome all types of contributions, from blueprint designs to documentation
to testing to deployment scripts.
To contribute to the documents, see
`OpenStack Documentation Contributor Guide
`_.
Bugs
====
File bugs on Launchpad and not through GitHub:
`Bugs:openstack-api-site `_
Install
=======
To learn more about the OpenStack project,
see `OpenStack `_.
Release Notes
=============
Release notes for the project can be found at:
https://docs.openstack.org/releasenotes/openstack-manuals/