Commit Graph

88 Commits

Author SHA1 Message Date
AgnesNM 04d6edb38a Include compound sorting information in docs
Compound sorting is an existing feature on the Horizon dashboard.
    It is not obvious, however.
    This change should bring this feature to the attention of users.
    It should also guide users into how to use the feature when sorting.
    Horizon DataTables.

    DocImpact
    Closes-Bug: #1287418
    Implements: compound sorting

Change-Id: I810e863e01ca54f6751e1608e99ce97833597aff
2024-03-28 19:45:25 +03:00
manchandavishal 605a515ebc Drop Django 3.2 support
Django 3.2 support was dropped. Django 3.2 ends its extended support
in April 2024[1]. Considering this, horizon dropped Django 3.2 support
and used Django 4.2 as the default version of Django. It also updates
some references to Django 4.2 from Django 3.2 in the documentation.

[1] https://www.djangoproject.com/download/

Change-Id: I9fff310c5433cf96cdf0a2cd81d11a96c2a4a55b
2024-01-30 17:01:51 +05:30
manchandavishal 89249f76e0 [doc] Add documentation about the release process in horizon
This patch adds documentation about the release process
in the horizon.

Change-Id: Iedcc857f0159dc7fea388e09469269130337ef5e
2022-03-31 04:33:10 +00:00
Zuul cf9a30d39e Merge "Address RemovedInDjango40Warning (3)" 2022-03-10 12:23:11 +00:00
Zuul d4b5646fb3 Merge "Add Python 3 only classifier" 2022-03-08 16:12:28 +00:00
Zuul ec1f1e0128 Merge "doc: Update setup file examples in the plugin tutorial" 2022-03-08 14:36:07 +00:00
Zuul dd9e4c82b5 Merge "Address RemovedInDjango40Warning (2)" 2022-03-03 10:14:04 +00:00
Zuul 8b4e31fbd6 Merge "Update default value of OPENSTACK_KEYSTONE_DEFAULT_ROLE" 2022-02-10 20:31:25 +00:00
Takashi Kajinami 569caf0b7f Add Python 3 only classifier
Python 2 support was removed during Ussuri cycle. This change adds
the classifier to clearly state that only Python 3 is supported.

Change-Id: I51552cadaed82b29dcd10043ba23a0682e549156
2022-02-08 23:27:26 +09:00
Takashi Kajinami fa29ed8e6d doc: Update setup file examples in the plugin tutorial
This commit updates the examples of setup.py and setup.cfg
to reflect the recent changes.

- Replace dashes by underscores in setup.cfg.
  Since setuptools v54.1.0[1], the parmeters with dash have been
  deprecated in favor of the new parameters with underscore.
- Update python versions in setup.cfg to match the current
  supported versions of python in OpenStack Yoga.
- Change the homepage URL in setup.cfg from horizon URL to a notice.
- Drop a workaround for python <2.7.4 in setup.py.
- Update the pbr requirement in setup.py
- Drop the unnecessary comment not to edit it
  as setup.py is not synced globally.

[1] https://github.com/pypa/setuptools/commit/a2e9ae4cb

Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: Id38299245f31d2db17fb1b74d60cf1232ee4a509
2022-02-08 22:53:25 +09:00
Akihiro Motoki d9266fd82c Address RemovedInDjango40Warning (3)
In Django 3.1, django.conf.urls.url() is deprecated
in favor of django.urls.re_path().

https://docs.djangoproject.com/en/4.0/releases/3.1/#id2

Change-Id: I484694f8718f61c022126a1935cf28fce075894b
2022-02-04 16:26:54 +09:00
Akihiro Motoki cd7c1b5110 Address RemovedInDjango40Warning (2)
django.utils.translation.ugettext(), ugettext_lazy(), ugettext_noop(),
ungettext(), and ungettext_lazy() are deprecated in favor of the
functions that they’re aliases for: django.utils.translation.gettext(),
gettext_lazy(), gettext_noop(), ngettext(), and ngettext_lazy().

https://docs.djangoproject.com/en/4.0/releases/3.0/#id3

Change-Id: I77878f84e9d10cf6a136dada81eabf4e18676250
2022-02-04 16:22:07 +09:00
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
manchandavishal a375c54186 Update default value of OPENSTACK_KEYSTONE_DEFAULT_ROLE
This patch update default value of OPENSTACK_KEYSTONE_DEFAULT_ROLE
to 'member' from '_member_'. If a user tries to create a new project now
it leads to "Could not find default role "_member_" in Keystone" error.

Also long time ago keystone-bootstrap changed the default member role
that is created to member from the legacy _member_ role. Any deployments
that might still be using _member_ should set this explicitly.

Closes-Bug: #1957173
Change-Id: I1fc7f44326b82ceb303f8d663ff0b42f0bdf7855
2022-01-17 11:21:31 +05:30
manchandavishal 8918bf751d Drop Django 2.2 support
Django 2.2 support was dropped. Django 2.2 ends its extended support
in April 2022[1]. Considering this, horizon dropped Django 2.2 support
and use Django 3.2 as default version of Django.

It also updates the python version from py38 to py39 for
"horizon-non-primary-django-jobs" and
"horizon-tox-python3-django" project template because py36
and py39 are now runtime for the Yoga cycle[2]. So I have updated it to
py39.

[1] https://www.djangoproject.com/download/
[2] https://review.opendev.org/c/openstack/governance/+/820195

Change-Id: I8886f12f7e51b721ac5123070086d5dcfefe4e72
2022-01-05 19:26:56 +00:00
Akihiro Motoki cdb08a1ad6 doc: Update our IRC server to OFTC
Change-Id: I985ea0b19a96e5e3160b824efda20659d855c2dc
2021-06-01 15:31:31 +09:00
Akihiro Motoki e0d348c643 Fix minor points in the policy doc
Change-Id: Idd4635a3ab337959d9b0ad4382eaf7274624ca8b
2021-04-01 13:08:20 +09:00
Zuul c756724cda Merge "Support policy-in-code and deprecated policy" 2021-03-04 22:01:52 +00:00
zhangboye f0460fc437 Use TOX_CONSTRAINTS_FILE
UPPER_CONSTRAINTS_FILE is old name and deprecated
This allows to use upper-constraints file as more
readable way instead of UPPER_CONSTRAINTS_FILE=<lower-constraints file>.
For more info. please refer [1].

[1] https://zuul-ci.org/docs/zuul-jobs/python-roles.html#rolevar-tox.tox_constraints_file

Change-Id: I1600df016b90383c77e179e186d8c58fa9868d92
2021-01-29 19:49:41 +00:00
Akihiro Motoki b7bb76eb20 Support policy-in-code and deprecated policy
This commit allows horizon to handle deprecated policy rules.
The approach is explained in the document updated by this change.

oslo.policy requirement is updated. oslo.policy 3.2.0 is chosen
just because it is the first release in Victoria cycle.
requirements.txt and lower-constraints.txt are updated accordingly
including oslo.policy dependencies.

Change-Id: If5059d03f6bd7e94796065aa1b51c0c23ac85f5e
2021-01-27 14:02:27 +00:00
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