Commit Graph

14 Commits

Author SHA1 Message Date
manchandavishal 83f864f490 Fix hardcoded link error in sphinx 4.4.0
horizon doc job is failing because sphinx 4.4.0 raise an error
for the hardcoded extlinks link [1]. This patch fixes those links
to unblock the doc gate job.

Closes-Bug: #1958290
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>

[1] https://github.com/sphinx-doc/sphinx/pull/9800

Change-Id: Ica1a16522421a697efdab882afe6d9c08ff05e0b
2022-01-21 11:42:14 +05:30
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 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
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
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
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
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
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 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
Amelia Cordwell 4d32b1fbe9 Add permissions explanation to quickstart doc
* Also fixes part of the example which showed having a custom
  permission that could not exist in the way that
  django_openstack_auth's keystone backend was implemented.

Change-Id: I46e748302d34f82648ef6690e2d5db4618487a6a
Closes-Bug: #1605842
2017-09-05 14:05:36 +12:00
Akihiro Motoki 497cae2b57 Use doc8 check
doc8 is a linter for documents and used in openstack-manuals.
It is better to enforce document linters for simple checking.

The current rules are really simple like:
- line length check (80 chars)
- new line at the end of file

Change-Id: I3810df521068ffc97e25a5fc56b72397bf9783bc
2017-07-19 10:31:16 +00:00
Rob Cresswell cae5379bf3 Reorganise and update the settings documentation
This commit is primarily a reorganisation fo our settings documentation.
The aim is to move away from the horizon / openstack_dashboard / django
distinction, which makes little sense to non-devs. This will be replaced
by a split between general horizon settings, service-specific settings,
and upstream Django settings. as well as organising the settings in
each section alphabetically. The aim is to promote discoverability of
settings for operators.

This patch also improves visiblity of deprecation, adds missing
tags (versionadded, seealso, deprecated, versionchanged), and
updates content where necessary. Some missing settings were added,
and many settings were also updated to reference other relevant
settings.

Change-Id: Idd496af7d4fe7d242772bb402d22c54c18f05d51
Implements: blueprint pike-docs-overhaul
2017-07-13 14:50:24 +01:00
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