Commit Graph

22 Commits

Author SHA1 Message Date
Tuan Do Anh 6f1004b67e Add release notes link in README
Change-Id: Ibf43dc5ba02958cb2c7fcafa14aadcedf8eb723d
2018-07-10 14:45:26 +07:00
Ivan Kolodyazhny 518621f930 Add a link to the documentation into the README.rst
Also this patch removes unnecessary index.html references.

Change-Id: I382c1c08a3a406cabf7b519521cf8a215c7d62b4
2018-05-13 19:28:22 +03:00
zhangdebo1987 7999914074 Correct docs link address in README
Change-Id: I23c9d3b3111b6c0a468ed6c467416465429a39ef
2017-08-03 09:18:56 +08:00
Doug Hellmann ce0c3eeec1 update doc URLs in the readme
Change-Id: I2622cf71272d98038e038848ba58b35dcc2a3dff
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-29 14:29:04 -04:00
Jenkins fa10215b31 Merge "Update and merge the install / deployment docs" 2017-06-15 13:28:48 +00:00
Akihiro Motoki df1c75ee6e README: Update how to generate the docs
TrivialFix

Change-Id: Icbebe797f0b054d198550829193dde25fb84ad21
2017-06-15 10:29:24 +00:00
Rob Cresswell de5bc4b46b Update and merge the install / deployment docs
These two documents were incredibly outdated, but also had almost
identical concerns. This patch updates the content and merges the two
documents.

Note that this guide is still separate to the quickstart guide, which is
intended for developers. In future patches in this blueprint, the file &
navigation structure will be altered to make this distinction more
clear.

Change-Id: Ic5d111d53ab69a3cd1ab08c4c05b2d676e79258c
Implements: blueprint pike-docs-overhaul
2017-06-15 10:40:24 +01:00
Flavio Percoco 371f4638dd Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/2b00c35799734733ecdec861c74975d8\n'

Change-Id: If27279ec325cefdf713dc924617429afc0834c87
2016-12-06 06:26:16 +00:00
Akihiro Motoki aa0f0ebc18 Add install guide for users and clean up README
* Add "Using Horizon" section to the docs, which describes
  how to install and configure Horizon. It is for operators
  who install Horizon from source code.
* Clean up README.rst as much of the information is out-of-date
  and most of it is covered by the developer docs.
* Minor update of page titles.

Change-Id: I09aab0d0bc47e07c8d663e7f7b5801e456434950
2014-10-09 03:29:26 +09:00
Gary W. Smith 628e908a3d Fix build instructions and formatting in README
- Fix manual build command
- Fix formatting of command-line examples, directory names
- Rename 'folder' to 'directory' for consistency
- Update sphinx URL

Partial-bug: #1257725
Change-Id: I078bc5b9c931d4bf4e57c8fe7b335db99cc92c29
2014-05-09 18:22:50 +00:00
Ana Krivokapic d3c91de71a Improve contributor documentation
Fix various errors in the contributor documentation:

- Factual mistakes (wrong file locations, etc)
- Formatting errors
- Typos

Change-Id: I4863ca10a532ac74491cfb19f8382e3d5287d2f3
2013-12-03 20:05:01 +01:00
Chad Lung 3b2cdf4ad8 Updating readme with grammar correction
Change-Id: I12c5f3a6bbe14c63cbbf59491e14821cc5e8f7d4
2013-10-24 16:23:01 -05:00
Sascha Peilicke a0739c9423 Drop NodeJS dependency in favor of pure-python lesscpy
While less.js from lesscss.org is still the most standard-compliant (err
defining) LESS implementation, a pure-python one will drasticly simplify
deployments.

Since lesscpy doesn't support {outfile} just write to stdout,
django_compressor will happily take that (See
http://django-compressor.readthedocs.org/en/master/settings/#django.conf.settings.COMPRESS_PRECOMPILERS)

Drop dependency documentation, there are no external (non-Python) tools
left to setup.

Meanwhile, lesscpy(>=0.9j) supports SVG stylesheets.

Change-Id: I89ed102f7be4b554a28b001c9c0d40dab4a51ae6
2013-08-16 09:31:08 +02:00
Jiri Tomasek 5b24518b10 Renames tools/pip-requires to requirements.txt
and tools/test-requires to test-requirements.txt

These are standard files and tools in the
general world are growing intelligence about them.

Change-Id: Iac3c680dd19cabd8ea38598a6e2bb27238030a2d
Fixes: bug #1179008
2013-05-29 12:07:35 +02:00
Clark Boylan f1a8e0c54f Move docs to doc.
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc and build results go in project/doc/build.

Change-Id: Ic523a716e4113198b777d6dc3db8bb8a729e7696
2012-06-12 11:41:04 -07:00
John Postlethwait 0074328fbb Updating Horizon to use LESS.
This changes all of the Bootstrap CSS and Horizon
CSS to use LESS. Horizon's specific CSS will be
organized into separate files in another commit,
as it is outside the scope of this BP.

We are also now packing LESS 1.3.0 directly within
Horizon.

Implementation of Blueprint transition-to-lesscss

Change-Id: Ie4be8b28ab3ce04ea21d7d5cd49c2ccb66bd8ade
2012-06-07 14:32:43 -07:00
Gabriel Hurley 873d9df357 Added "network" to the list of required nova services.
Fixes bug 967987.

Change-Id: Icd6ac8c332815de86b2333640f454a0e8c91e982
2012-03-29 18:13:04 -07:00
Gabriel Hurley 6999780204 Updated docs to reflect current required services for Horizon.
Fixes bug 946874.

Change-Id: Ieaac7f102047be1d6fb17f129bd2b74d13a1dc4c
2012-03-13 13:11:16 -07:00
Tres Henry 9bea7957dc Made readme a little more clear on where to put local_settings.py
Change-Id: I670f6dd57e259fded7ce206380d0a3d588d4083d
2012-03-02 16:17:33 -08:00
Gabriel Hurley 052aa55d34 Unifies the project packaging into one set of modules.
There are no longer two separate projects living inside the horizon
repository. There is a single project now with a single setup.py,
single README, etc.

The openstack-dashboard/dashboard django project is now named
"openstack_dashboard" and lives as an example project in the
topmost horizon directory.

The "horizon/horizon" directory has been bumped up a level and now
is directly on the path when the root horizon directory is on
your python path.

Javascript media which the horizon module directly relies upon
now ships in the horizon/static dir rather than
openstack-dashboard/dashboard/static.

All the corresponding setup, installation, build, and env scripts
have been updated accordingly.

Implements blueprint unified-packaging.

Change-Id: Ieed8e3c777432cd046c3e0298869a9428756ab62
2012-02-29 00:20:13 -08:00
Gabriel Hurley a17570110f Unified horizon and openstack-dashboard environments.
Buildout has been removed entirely, all dev installation is now
done via the single tools/install_venv.py script.

Django's manage.py script has also been updated to a newer
version/convention; this allows for less python path mangling
and makes things cleaner and more explicit. Note that, as such,
it has been moved up a directory level.

Change-Id: I62f9f06ee00568fc91e5ba7e1fd15d22ea849d1f
2012-01-05 13:57:07 -08:00
Duncan McGreggor a9df378281 Gave the README an extension that github would recognize and then render.
Change-Id: I54fb08b3421b47d98df649d36b9f29726d5aa0ca
2011-12-02 12:34:27 -08:00