68 Commits

Author SHA1 Message Date
Akihiro Motoki
3c0f69ee1e Document bug triaging process
Change-Id: I8f517b80c1e70a38925c8807c8e0c692b8ab2227
2020-12-10 09:44:41 +09:00
Ivan Kolodyazhny
57999617ec Update docs for Ubuntu 20.04
* Add gettext package for development environment
* Use 'apt install' command instead of legacy 'apt-get'

Change-Id: I2bd06b7708a72a1986e75968aee79ba27457bf62
2020-11-12 12:36:11 +02:00
Akihiro Motoki
1b8bf35b9d doc: Document teams in horizon
Several teams are defined in the horizon project both in
gerrit and launchpad. It would be nice to document them.

Change-Id: Ic88912f6216bcef020a0839380f6528705a0a1a7
2020-10-08 16:02:38 +09:00
Akihiro Motoki
e0afd0d21d [ussuri] [goal] Project PTL and contributor docs
This commit updates the horizon contributor docs to follow
what the community goal [1] recommended.

* Reorganize doc/source/contributor/contributing.rst to the format
  suggested in the community goal template.
* Cleanup obsolete information and topics covered by the general
  OpenStack contributor guide.
* Move contributing.rst to the top in TOC of the contributor guide
  as it is considered as the entry point for new contributors.
* Sync CONTRIBUTING.rst at the top level directory with the
  community goal template.
* Update the core reviewer expectation along with PTL expectation.

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38525

Change-Id: Idce7fc08e7fdf854d8a7bca55169d18403362c45
2020-08-20 08:34:11 +09:00
Akihiro Motoki
c897a8e444 doc: Reorganize contributor doc
Ussuri community goal "Project specific contributor and PTL docs"
want us to use doc/source/contributor/contributing.rst as an entry
point, but the current contributor/contributing.rst in horizon
contains a lot of information.

Before updating the file to satisfy the community goal criteria,
this commit reorganize the contributor doc.
It splits the existing contents in contributing.rst into pieces.

Change-Id: I8aa9a310a99e0eed5a93ed040a02a2829ee09bf7
2020-08-20 08:34:11 +09:00
Akihiro Motoki
49a6d67e49 doc: update how to run specific test in pytest
pytest has a different way to run specific test from django test runner.
pytest migration patch did not update our document.
This commit is a follow-up patch.

Change-Id: Ifed388928f159a5a602088b2cfbf7f601d044387
2020-04-27 13:18:29 +09:00
manchandavishal
c54ee9bd05 [doc]Correcting broken link
The old url reports 404 Not Found, so fix it.

Change-Id: Ib91d40050241318a1f466160c23f9ae27301af82
2020-02-12 08:21:07 +00:00
Stephen Finucane
2b3ab46440 Remove errant references to mox
There is still a single user of mox but all other references to this can
be removed. Do just that.

Change-Id: I611573a41c47e99e41a54bf53cea55322a493de1
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2020-01-30 10:35:50 +00:00
Akihiro Motoki
c5dd1536a0 Prepare non-primary Django tests in zuul jobs
We already have a template 'horizon-non-primary-django-jobs'
to test horizon and plugins with non-primary django versions,
but we still need to update tox.ini in all horizon plugins
whenever we change Django versions used.

This commit prepares per-Django environment in the zuul job.

Per-Django tox environments like py3-{dj111,dj20,dj22} are
no longer needed. It would be a big merit that we will no longer
need to update tox.ini in all horizon plugins.

The downside is that we do not provide a convenient way to
test it locally, but I think it can be covered in the document.

Change-Id: I726b19130ee9e7d06eb33231071c2673cfd3a49f
2019-12-29 05:20:33 +09:00
Akihiro Motoki
3e54ba096f Complete "Drop Python 2.7 Support" goal
The goal definition in the TC repo [1] defines the completion criteria.
We have already completed 1, 2, 3 and partially 4 in [1].
This commit completes 4 (requirements.txt etc) and 5 (release note).

Python dependency in the installation guide is updated.
Django support plan in Ussuri is updated as well.
References to python 2.7 in the document are updated as well.

[1] https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Change-Id: I0383920e32e053e1611519be774fab8dec124ccc
2019-12-29 01:42:54 +09:00
白子玉
3f7fc68085 Changed default identity url to horizon
The keystone doesn't use 5000 port anymore from Newton version. And all
 the references should be changed together.

Change-Id: I3f02686ab5b3abf48f129fde92e90427ca148317
2019-12-06 18:41:38 +08:00
Zuul
b068440330 Merge "doc: Move DevStack local.conf to "Topics" section" 2019-10-29 17:55:14 +00:00
Zuul
d0717b7d1b Merge "doc: Update local.conf example" 2019-10-29 08:04:51 +00:00
Akihiro Motoki
882b5f0582 Assume features from N-4 release instead of N-3
Curretnly, features from N-3 release are assumed as a baseline
in the horizon development policy document.
LTS of Ubuntu Cloud Archive supports upgrade from N-4 to N.
If we assume a case where horizon is upgraded first, N release of
horizon needs to be able to run with N-4 release of back-end services.
The difference of N-3 and N-4 would be small, so it sounds reasonable
to assume features from N-4 release.

N-4 is chosen considering LTS support in the major OpenStack distributions:
* Red Hat OpenStack Platform (RHOSP): X -> X+3
  https://access.redhat.com/support/policy/updates/openstack/platform/
* SuSE OpenStack Cloud (SOC): X -> X+2
  https://www.suse.com/releasenotes/x86_64/SUSE-OPENSTACK-CLOUD/8/#Upgrade
* Ubuntu Cloud Archive: X -> X+4
  https://www.ubuntu.com/about/release-cycle

Change-Id: If7007e9d5b912b48d6bf3e4fac5decc53cd8388b
2019-10-15 15:11:47 +09:00
Ivan Kolodyazhny
4a9a50f2bf Update How to run the tests section
Added note how to run integration tests and updated supported
Django versions.

Change-Id: I0edff1da161b27e060b13dda2ef3f98ad5ee58e1
2019-10-03 08:42:10 +00:00
Ivan Kolodyazhny
13c7a4916a Update the list of required packages for Development Environment
This list was tested on a fresh Ubuntu 18.04 and CentOS 8
environments without Devstack.

Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: Ib009e036d9fcebdad8faeb5d30ed14c525fabf10
2019-10-01 16:57:10 +03:00
Akihiro Motoki
e75a036cda doc: Move DevStack local.conf to "Topics" section
contributor/ref/ directory contains the module reference and
local.conf was the only exception. "Topics" section looks
more appropriate place to have a guide to configure DevStack
for horizon.

Change-Id: Ibfafe7c608753633e0b78765073afa2924602551
2019-09-27 18:53:03 +09:00
Akihiro Motoki
97267ff10b doc: Update local.conf example
* Remove sample devstack configuration from local.conf.
  DevStack document provides the full set of configuration.
  There is no need to have sample configurations and descriptions
  in horizon.
* Change default passwords to match passwords used in the OpenStck CI.
  It helps developers reproduce CI configurations in local envs.
  If these passwords are different, we need to (re)configured
  passwords for MySQL, RabbitMQ and so on.

Change-Id: I9540df7a1390aa0411713ea80d711e8cfc09292d
2019-09-24 18:29:48 +09:00
Akihiro Motoki
48ac863f76 Document the plan of ini-based-configuration
This commit tries to summarize the approach of ini-based-configuration
effort and the preparation for it.

Part of blueprint ini-based-configuration

Change-Id: I810a2f3c5d13fe70d840aa6460cb902f566c29b8
2019-04-30 05:18:10 +09:00
ZhongShengping
a569f0faf3 Replace git.openstack.org URLs with opendev.org URLs
Thorough replacement of git.openstack.org URLs with their opendev.org
counterparts.

Change-Id: I7f5506455ed52e4670b8e428548e931db13b13db
2019-04-24 12:25:40 +08:00
YAMAMOTO Takashi
f722d2bb17 django.core.urlresolvers -> django.urls in doc
Change-Id: I75adb9aad6d5deed027625fca8e07b6ed5a1cf42
2019-04-04 15:37:20 +09:00
manchandavishal
3b6c944ff5 Update python3 version info
In Train, we will use python 3.6 and 3.7 for python3 runtime
in our gate jobs [1]. This commit drops python 3.5 info
and adds python 3.6 and 3.7 info.

[1] https://governance.openstack.org/tc/reference/runtimes/train.html

Change-Id: I8f024505ed9b37c9f2b480f49b5000d75da42cc0
2019-03-29 10:32:52 +00:00
manchandavishal
58211d6284 Updating Note to Setup guide
Due to [1] patch it's better to update [2] file.
Otherwise it create confusion to a new devloper if use
"tox -e runserver" for developments.

[1] https://review.openstack.org/#/c/630790
[2] openstack_dashboard/local/local_settings.py.example

Change-Id: I2146b33f46c417c5f1d61a4958336c92f0c03e9c
2019-03-05 16:32:52 +00:00
Zuul
aa5e7b822b Merge "Document horizon policies" 2019-02-12 21:50:33 +00:00
Akihiro Motoki
8f39950a0e Document horizon policies
This commit tries to capture basic policies on back-end feature
supports and so on that have not documented so far.

Change-Id: Ic1dc6029ce2a1cf54d313e8320b7ca206f5dfaea
2019-01-15 16:19:28 +09:00
Zuul
c1629e30dc Merge "[doc] Fix: Tutorial: Building a Dashboard" 2019-01-11 15:54:55 +00:00
manchandavishal
40e36a1c8c [doc] Fix: Tutorial: Building a Dashboard
The directory structure after executing the commands is
different from the document provided.
This patch make it consistent.

Change-Id: I5a78765c4760d3bc0b27a0f67f2d47960fd4824d
2019-01-11 05:04:03 +00:00
Akihiro Motoki
5e07d03f90 doc: Remove errant newline in the plugin tutorial
{% include %} syntax cannot have a newline.

Closes-Bug: #1774054

This commit also cleans up several things.

* setup.cfg: Rename "classifiers" to the correct keyword "classifier"
* setup.cfg: Add Python 3 classifier
* Quote literals

Change-Id: I14c2217a69ea489c72b311b26b5eb4a5e4865059
2019-01-09 02:06:03 +09:00
gaoyl
f41df5a800 Fix folder path in "AngularJS Topic Guide"
Change-Id: I319b12f85bd03b4e12395fbdeff54650a11d7456
2019-01-03 12:23:57 +00:00
zhangdebo
a548d464d1 Update link addresses in documents
Change-Id: I838adb8fface6f0931007e859dc3779238923e5a
2018-11-24 10:37:39 +08:00
zhouxinyong
23313c7ec3 Update the HTTP links to HTTPS.
Change-Id: I7c45f9a54be390df2d965e181c581b26f17e70d5
2018-11-15 09:57:17 +00:00
zhu.boxiang
3ba15b4524 Replace Chinese quotes with English quotes
Replace chinese double quotes with English double quotes

Change-Id: Iec7305c4d0a879cc69bde90771741b527bfe5232
2018-09-11 16:07:43 +08:00
zhangdebo
8c22e6e098 Replace Chinese quotes with English quotes
Change-Id: I815a9b0ce2d2e277bb55a9315f877848cdc768d9
2018-09-09 23:26:52 -04:00
Qian Min Chen
e47f695400 [doc] Remove the redundant "required=True"
The django form field default is "required=True", so there
remove the redundant "required=True" in doc.

Change-Id: Id88e0a4d8e97e78ce8e6be760d67f0db3d69f50c
2018-08-30 22:38:40 +08:00
Qian Min Chen
bbfa5620ce [doc] Correct the wrong virtual environment folder name
Change-Id: I3d5a3e243fbc897a3b42f72be815988089c59d2c
2018-07-12 10:01:41 +08:00
Akihiro Motoki
8230f2cf7a doc: Fix doc build failure due to dropped UpdateAction
Change-Id: Iae027ff58a4924fb3cfea1f9eaf07f357c861de8
Closes-Bug: #1769777
2018-05-08 09:36:11 +09:00
huang.zhiping
09f73b81cc Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: Ic974b5e586bc24609560986057f753bd39d546fe
2018-04-30 09:11:09 +08:00
Radomir Dopieralski
93bb571888 Replace all mentions of get_identity_providers with get_identity_provider
There was a typo in keystone's policy files, and it has been fixed in
Keystone already, we should also fix it to match.

Change-Id: I41e4381765f3bfc5988ca235e6cbeb6d1ba62fc2
Closes-bug: #1703369
2018-04-25 11:37:05 +02:00
Ivan Kolodyazhny
f6f39d86da Remove deprecated table.UpdateAction class
UpdateAction is deprecated in Newton and is used in unit-tests only

Change-Id: I7952cb77b168cc39f8fc37c3b7ffe0c830d4e0d4
2018-04-12 17:34:17 +03:00
Zuul
6e09bfa700 Merge "Remove 'tools/install_venv.py' reference paragraph" 2018-01-30 02:11:21 +00:00
gaofei
7dd4d7a99d Remove 'tools/install_venv.py' reference paragraph
Since 'tools/install_venv.py' has been removed during refactor[1].
This paragraph displayed in quickstart may cause some confusion to
someone who new to horizon, so remove this paragraph.

[1]6529cd1eb8

Change-Id: I302ef1f30781ce916c7309ebfa349fbedf8dd5a6
2018-01-30 00:42:12 +00:00
Zuul
0cbbc046d5 Merge "doc: use "python manage.py" directly rather "tox -e manage"" 2018-01-27 04:37:45 +00:00
Zuul
04bce70472 Merge "doc: update policy related topics" 2018-01-25 21:13:44 +00:00
Akihiro Motoki
ea06895ec8 doc: update policy related topics
* topics/policy.rst and settings.rst both contain settings related
  to policy engine. All settings are now defined in settings.rst.
* Add contents to maintain policy files. The process after switching
  to policy-in-code is covered.
* Add subsections to "How to Utilize RBAC"

Change-Id: I912543ad6bef02e37ba4e2fec27dcdff61f89d23
2018-01-14 05:59:28 +09:00
Akihiro Motoki
5a11dd64b1 doc: cleanup unnecessary vertical lines
If a content has unnecessary indent, we will have unnecessary
vertical gray lines in rendered HTML like [1].

[1] https://docs.openstack.org/horizon/latest/configuration/customizing.html#icons

Change-Id: I69140e396db80c5008d60db64b83f7cdb5a891d8
2018-01-14 05:45:35 +09:00
Zuul
44714c17f3 Merge "Updating default keystone API verson to 3" 2017-12-29 18:04:49 +00:00
Akihiro Motoki
6c45c47e4b Drop unnecessary executable flags
This patch also adds checks for executable files in
pep8 job.

nose ignores executable files by default, so it is important
to ensure executable flag is not set for test files [1].
openstack_dashboard/test/test_plugins/panel_tests.py was not
tested actually and it was broken. This commit fixes it too.
[1] http://nose.readthedocs.io/en/latest/usage.html#cmdoption-exe

Co-Authored-By: Ivan Kolodyazhny <e0ne@e0ne.info>
Change-Id: I3a124fa2f9f0676b2b43a094e32e3d8b18fa6005
2017-12-27 21:32:48 +00:00
Akihiro Motoki
cd49510878 Updating default keystone API verson to 3
The keystone API version 3 has become the default API version
for a long time and our CI already uses keystone v3 API only.

In addition, our documentation recommended to use the cached session,
so switching the default API version to 3 does not hit the limitation
on the maximum size of session data when using the cookie-based
sessions.

This is based on django_opensatck_auth review
https://review.openstack.org/#/c/158384/

Implements blueprint: default-keystone-api-3
Change-Id: I79e9fbd3567cc69468694dbf043fecf422347c7e
2017-12-21 03:24:07 +09:00
Akihiro Motoki
a57d8b0e15 doc: use "python manage.py" directly rather "tox -e manage"
According to bug 1737242, tox -e manage collectstatic/compress
can fail with a customized settings file (for example, a setting
which uses db backend for caching). After discussion with the bug
reporter, he develops a theme using a production settings file
and runs into a trouble. It looks better to use python manage.py
directly to avoid further confusion.

Change-Id: If34ba249745a110268cc99213cc404697b03495f
Closes-Bug: #1737242
2017-12-12 00:14:23 +09:00
Akihiro Motoki
eac3e7032a Drop Heat related code from horizon
Orchestration tab in the admin info panel needs a discussion.
It seems not to be covered by heat-dashboard yet.

blueprint heat-dashboard-split-out

Change-Id: I56e6edb1f2ac72e2f42d0e9f3291308e67f24cad
2017-12-05 07:38:55 +00:00