Commit Graph

15 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
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
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
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
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
Akihiro Motoki 1b0bd0d045 Move openstack_auth API refernece into a separate place
Part of blueprint merge-openstack-auth

Change-Id: I5c5aec5899a3ba18f90ab5ca8d381aeea86b7a5e
2017-11-16 11:11:02 +00:00
Rob Cresswell e3e5812b19 Add Django OpenStack Auth to Horizon
Moves Django OpenStack Auth content to Horizon, since they are so
tightly coupled. This cleans up the development workflow and should
make keystone / auth related contributions easier.

Implements: blueprint merge-openstack-auth
Change-Id: Ia1cdc47bad1ca6e633073a9f9445b0c7f70d05bc
2017-09-27 12:06:57 +01:00
Rob Cresswell b4914c4caf Remove remainder of run_tests references
Change-Id: I74245159e8c4e17056170fe4a573ad899676aea6
2017-08-29 08:15:24 +00:00
Akihiro Motoki 515ba0ae0f Update the documentation link for doc migration
This commit updates links affected by doc migration.
Note that other links are not touched in this commit.
Fixing other broken links or changing http to https
should be covered by a separate patch.

Also convert http links to docs.openstack.org to https per reviewer
request (though it is not directly related to doc-migration).

Note that this commit does not touch files under releasenotes/notes/.
If we touch release notes in older releases, reno will considers
it as a release note in the current release.
(Pike release notes are clean up in a separate patch.)

Change-Id: Iba9bd465ef08014a4972584cf4da6e7d77961119
2017-08-04 18:38:25 +00:00
Rob Cresswell 6cd4b03447 Update local conf
implments: blueprint pike-docs-overhaul

Change-Id: I6a05d25717d98e9ceeb337142cfee327d27c03b7
2017-07-27 11:13:49 +00: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
Akihiro Motoki 563908e2c0 doc: cleanup formatting
* Clean up unnecessary vertical quotes at the left side
  caused by extra spaces at the beginning of lines.
* Do not use backquotes in the title lines
  (ref/run_tests.rst, ref/horizon.rst)
  When backquotes are used in the first-level title,
  it will be included in the navigation at the top-right corner
  https://docs.openstack.org/developer/horizon/contributor/ref/index.html
* Remove duplicated contents:: directive in ref/run_tests.sh.
  openstackdocstheme generates the toc by default, so having contents::
  directive leads to duplicated toc in a page.

Change-Id: Icc641927ad7cd7a8d79632c64a3ce212f0dc0b64
2017-06-29 17:59:09 +09:00
Alok Kumar 56e917049d Fix improper `next` and `previous` links in docs
Currently two pages inside contributor/ref/ section of horizon
doc has incorrect next and previous links. It shows text as well.

This is due to use of literal markup in rst title field. Removing
this fixes it.

One can see broken page at
https://docs.openstack.org/developer/horizon/contributor/ref/run_tests.html
and
https://docs.openstack.org/developer/horizon/contributor/ref/horizon.html

Change-Id: I8d450493ec847e85ec71500581c154ecd80df788
Closes-Bug: #1701134
2017-06-29 06:21:49 +05:30
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