Commit Graph

25 Commits

Author SHA1 Message Date
Doug Hellmann 259746bcff rearrange content into the new standard layout
Change-Id: I6dbe0ea81d9d21a0f92d270337637606220f38d1
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-15 17:40:10 -04:00
Rob Cresswell 7ce250f2c3 Fix the CLI symbol in the quickstart doc
The CLI propmpt symbol in the updated doc was changed to #, which
implies root. Lets not encourage people to run a bunch of things as
root. This patch reverts it to $

Change-Id: Iac7343e676cc58b79e7328cdbad1652f98da0ecf
Implements: blueprint pike-docs-overhaul
2017-06-14 17:07:11 +01:00
Rob Cresswell 6eb8394213 Update the quickstart guide
This patch is the first in a series improving Horizons documentation. It
aims to make the initial quick start section clearer, updates the
information to remove some redundant information, and updates the
appearance to match the rest of the openstack docs.

Change-Id: I942e62b6c2c272dc2b5c91bca42c77677bb4e09d
Implements: blueprint pike-docs-overhaul
2017-06-08 21:01:37 +01:00
Rob Cresswell 36d1d1ac68 Refactor tox & update docs
- Updated tox envlist, so just running `tox` from the CLI will now run all
voting gate tests

- Reduce duplicated definitions and commands

- Remove any reliance on run_tests within tox

- Removes all doc references to run_tests.sh, and replaces them
with their tox equivalent. Where necessary, language around the tox
commands has been altered or extended so that it makes sense and is
consistent with other parts of the docs. Also adds a new "Test Environment"
list to the docs, so that newcomers do not have to piece together CLI
commands and their cryptic extensions from tox.ini

- Move the inline shell scripting to its own file. Also fixes a bug when
passing args, since the logic assumed you were attempting a subset test
run (try `tox -e py27 -- --pdb` on master to compare)

- Moved translation tooling from run_tests to manage.py, w/ help text
and arg restrictions. This is much more flexible so that plugins can use
it without having to copy commands, but still defaults to exactly the
same parameters/behaviour from run_tests. Docs updated appropriately.

- Removed npm/karma strange reliance on either .venv or tox/py27. Now
it only uses tox/npm.

Change-Id: I883f885bd424955d39ddcfde5ba396a88cfc041e
Implements: blueprint enhance-tox
Closes-Bug: 1638672
2016-11-30 20:38:59 +00:00
Paul Karikh ce5fb26bf5 Remove admin role name 'admin' hardcode
Because of hardcoding name as the 'admin' was impossible to
use administrative panel with a custom administrative role name.
This fix replaces hardcoding the name of the administrative role
with RBAC policy check.

DocImpact
Related commit: https://review.openstack.org/#/c/123745/
Change-Id: I05c8fc750c56f6f6bb49a435662e821eb0d6ba30
Closes-Bug: #1161144
2016-05-31 10:38:22 +00:00
Matthias Runge 83b04c730e Fix misc small issues with docs
Apparently, it was forgotten to update IE reference in docs
there too.

Change-Id: Id35b75fca6f801633f89c4c2ed7ee369fe345537
2016-02-11 10:16:28 +01:00
Shan Guo 97114cb990 Modify the Quickstart-horizon doc grammar
Change-Id: Ieb89c92c83216e90b110ba7187d8c4ae66e3c4aa
2015-11-13 11:05:52 +08:00
Justin Pomeroy 0ee581d4ba Remove environment_version ref from quickstart guide
This updates the horizon quickstart guide to remove the reference to
the environment_version variable in the run_tests.sh file. This no
longer exists.

Closes-Bug: #1511790
Change-Id: Ide7fff19d53b67da8d3a05a275e814339f5e54a3
2015-10-30 11:59:01 -05:00
Ami Jeain d5021f4dd2 add the package 'which' to fedora
in fedora minimal installations, the package "which"
is not included, but required for run_tests.sh to install
necessary dependencies

Change-Id: I31b43de1f0f72be2d8d3d97af2909744080ad706
2015-03-12 16:23:09 +02:00
Jenkins 84b3915dcc Merge "Added a migrate_settings command" 2015-02-20 21:44:10 +00:00
Yves-Gwenael Bourhis 9610f0bed0 Added a migrate_settings command
This command allows to easily save a diff between local_settings.py and
local_settings.py.example to reapply the change when local_settings.py.example
changes (per branch switch or updates).

implements bp settings-migration-script

Change-Id: I2668bbf248434a5d437a5fc46ad07c1a1f29b793
2015-02-05 12:24:18 +01:00
lawrancejing fed29ee138 Clean unused code for `supports_tenants`
It seems that the `supports_tenants` attr is unused now,
the patch clean up some code related to `supports_tenants`
so that the code can be more readable for devs:)

Closes-Bug: 1417841
Change-Id: Ia3def66b34bf91a4a4e2d7bcb61c5f3be1d16abb
2015-02-04 10:10:49 +08: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
David Lyle 38007b942e Amending the quickstart guide
*Updating to avoid use of manage.py directly.
*Making it more DevStack friendly.
*Adding a sample DevStack local.conf to allow for exercise Horizon
 against more services.
*Added simple developer instructions so new developers aren't tempted
 to work on the DevStack instance of Horizon.

Change-Id: I0840c63183e7cec3b08e4f2ce208479ff7552f60
2014-10-01 16:20:36 -06:00
mariamj@us.ibm.com 59d8866023 Refer local_settings in doc to customize settings
There are couple of places in the docs where it isn't explicitly
mentioned whether to modify settings.py or local_settings.py to
customize settings (this might not be obvious to people who are new
to Horizon and Django).

The changes include:
- In the `Customizing Horizon` guide, under the section 'Modifying
  Existing Dashboards and Panels', explicitly mention local_settings.py
  file to be modified to update ``HORIZON_CONFIG`` setting
- In the QuickStart guide, under the `Setup` section, add a note which
  mentions that to customize any settings use the local_settings.py file
- In the 2013 Havana release notes, under section `Upgrade Information'
  for 'Allowed Hosts', specify only local_settings.py file to add the
  new 'ALLOWED_HOSTS' setting (instead of settings.py or local_settings.py)

Change-Id: I38314cadd8a5a61d1edea26c6cd0d34e713fd66c
Closes-Bug: 1301484
2014-04-14 00:35:12 -04:00
Ana Krivokapic 2c464340a4 Fix documentation about adding a new dashboard
Since blueprint plugin-architecture has been implemented,
the preferred way to add a new dashboard is a configuration
file, rather than an entry in INSTALLED_APPS.

This patch changes the developer documentation to reflect
this change.

Change-Id: I569b22b81da1442ec9bed13d50ebfccfff093ac7
2014-04-02 18:35:15 +02:00
David Lyle ea0ba693e4 Adding missing system dependencies to quickstart
libffi-dev(el) recently became a system dependency and is not
documented in the quickstart guide.

Closes-bug: #1298587
Change-Id: I6722f9c600335213408f53b81d4a2915a0dc3bf5
2014-03-27 14:22:49 -06:00
Robert Mizielski 658ebab4be Add dependencies on Quick Start page.
Change-Id: Ifc69ae397519c05d778d4d15062c00ae8e425b9d
Closes-bug: #1231227
2014-01-29 11:52:12 +01: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
Kev Bittner e6ed24f1c1 Changed "panels.py" to "panel.py"
Change-Id: Idc5313834b43060ff552017dfcaeacd8d5b62444
2013-10-24 15:13:36 -05: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
Matthias Runge a209ed40f4 Remove the term 'syspanel' from docs
Since the refactorization of syspanel occurred at
the very early Folsom days, the docs should reflect this too.

Change-Id: I8539b0b8bda2f63366c6de75b1a010f52f07fd0e
2013-04-26 09:07:44 +02:00
jakedahn 495730174e Clarifying Quickstart Documentation.
* Fixes bug 1031213

Change-Id: I0db6661b01ce01b8bc51911ded02fd9877ad9974
2012-08-15 11:48:05 -07:00
Gabriel Hurley c339189b44 Auth refactor.
Switch to using the self-contained django_openstack_auth
package which is a proper django.contrib.auth pluggable
backend.

Notable functional improvements include:

  * Better overall security via use of standard Django
    auth code (well-vetted by security experts).
  * Token expiration checking.
  * User "enabled" attribute checking.
  * Support for full range of Django auth attributes
    such as is_anonymous, is_active, is_superuser, etc.
  * Improved hooks for RBAC/permission-based acess control.

Regarding the RBAC/permission-based access control, this
patch moves all "role" and "service"-oriented checks to
permission checks. This will make transitioning to
policy-driven checking much easier once that fully lands
in OpenStack.

Implements blueprint move-keystone-support-to-django-auth-backend

Change-Id: I4f3112af797aff8c4c5e9930c6ca33a70e45589d
2012-07-09 16:57:52 -07: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