29 Commits

Author SHA1 Message Date
Vida Haririan
5eac91ce6b Update Refstack Docs
Removed Option 2 install docs and associated files.
Renamed Option1AnsiblePlaybook.rst to refstack_setup_via_ansible.rst
, move to /refstack/doc/source

Change-Id: I1cc309c9a1bec622aadfcf0840c546d3d243e7c5
2023-06-05 11:50:39 -04:00
jskunda
9e79b3b4ae Fix missing about content in refstack-ui
Refstack webpage's about section is not rendered correctly. The bug is
tracked in here:
https://tree.taiga.io/project/openstack-interop-working-group/issue/81

This patch will update documentation build process to generate html
files by changing paths to html files in about.html.

Replace deprecated options in doc/source/conf.py by the new ones:
* openstackdocs_bug_project
* openstackdocs_bug_tag

Change-Id: Id296b9cecf75bb289b0da41bec880a13694298e1
2023-04-18 19:07:50 +02:00
Martin Kopec
8daea3e908 Add contributing page and some updates
The commit adds contributing page for easier orientation
in our projects.

Change-Id: Ida438dd72ffd004e858f21065f8c65fde4d7a23a
2021-11-15 14:36:25 +00:00
Martin Kopec
5eb0e719fc Reflect osf/ to openinfra/ namespace rename
Lately osf/ namespace got renamed to openinfra/ [1], this commit
reflects this change within refstack's repo.

[1] https://review.opendev.org/c/openstack/project-config/+/808479

Change-Id: Id8ff246faf19ac67ed6c9dc5ab2514c4655a0610
2021-10-21 22:35:42 +00:00
lpiwowar
42df359990 Fix documentation structure
This patch fixes the structure of the Refstack documentation and
tries to make it more readable.

Change-Id: I4ae3a0274b1f3201a44bbac516c00f16dec5ce55
2021-10-18 11:27:11 +02:00
Martin Kopec
5790634ff4 Update documentation, add playbook for developers
The patch updates the user-faced documentation and adds a playbook
together with a doc meant mainly for RefStack developers which
helps with running the server instance locally.

Change-Id: I268fdf717c8f0e2cd0c130c560306bf54e48f348
2021-06-25 10:11:36 +02:00
Goutham Pacha Ravi
78c4ce8ac8 Fix broken links and redirects
This repository is hosted on opendev.org's
gitea server, and doesn't get mirrored to
github currently (we may add mirroring in
the future). We can swap a bunch of URLs
that assume the content is on github and
older infra cgit servers with correct URLs.

Meetings have moved from IRC to MeetPad,
fix the corresponding details in the README.

Also use this commit to strip trailing
whitespaces across the repository.

Change-Id: Ica0a7ba08d9c437f94fbc9ab282bd929f01df8ff
2021-01-08 21:17:29 +00:00
Clark Boylan
0af3a46e16 Force PEM filetype with ssh-keygen
At some point ssh-keygen changed its default output format and now
python cryptography can't read the new default. Address this by forcing
the PEM output format which cryptography can read without problems.

Note this is a docs only change to help end users generate keys that
work with refstack after a user reported trouble with this.

Change-Id: I9d1f503817fee69fe22f19a98b506448bda1f888
2020-05-06 14:42:23 -07:00
Martin Kopec
b6f9f8611b Change testrepository for stestr in doc
Tempest has switched from stestr some time ago, so tempest
results are no longer stored under .tempest/.testrepository
but they are stored under .tempest/.stestr instead.

Change-Id: I2f0f47c8989138b361375ba91c1e9cd719ea9a8b
2018-10-18 20:43:49 +00:00
Dao Cong Tien
174b5ca87d Invalid link of doc reference
Change-Id: If865b4093796ad99741583d6a10e53578f3f7bd9
2018-07-11 15:10:19 +07:00
Megan Guiney
23c5dc54fb add nodejs install back into setup docs
If not explicitly installed, node packages fail to resolve
properly.

Change-Id: Id18e6004f82b51904ea18eb674cef10490d0e427
2018-06-25 10:56:22 -07:00
Megan Guiney
aee81c6121 fix documentation formatting
New documentation regarding how to install yarn needed double
newlines rather than the current single newlines. As is, it is
rendering as a single line, which is obfuscating eyesore.

Change-Id: I4a3e921342703ea00a4ab622b304c70250006063
2018-06-16 00:11:00 -07:00
Chris Hoge
902d0362c7 Migrating from bower to yarn
* Works with the Docker development image
  * Requires an upgrade to Node 8
  * Using bower-away and yarn for simplicity

Change-Id: I353fb2f01f50f88707341369221d32ac9de513b1
2018-06-13 16:19:14 -07:00
Vu Cong Tuan
ad0340077b Do not use “-y” for package install
According to "code conventions" [1], do not use "-y" option.
Instead, use apt-get install package, yum install package,
or zypper install package.

[1] https://docs.openstack.org/doc-contrib-guide/writing-style/
code-conventions.html

Change-Id: I11ffc5627f32a9300a5fea0d79d334c3acf09b0f
2017-11-08 14:38:10 +07:00
Luz Cazares
9e4970217e Update Refstack docs for documentation migration
This patch updates the Refstack documentation in support of the
OpenStack documentation migration[1]. Follow guide on [2]
Refstack documentation is displayed under Related Projects [3]

[1] https://specs.openstack.org/openstack/docs-specs/specs \
    /pike/os-manuals-migration.html
[2] https://docs.openstack.org/openstackdocstheme/latest/
[3] https://docs.openstack.org/openstack-projects.html

Change-Id: I6f3fbfcf8240da6aa1ee6f754205c5b615eec3d0
2017-07-10 19:26:08 +00:00
Jenkins
92bf63aa9d Merge "Add docs to about page" 2017-05-23 17:55:28 +00:00
Paul Van Eck
01bc37c241 Add docs to about page
This commit adds a script that will convert RST files to
basic HTML templates. The about page is also adjusted to
assume that this tool will be run and that documentation
templates will be available.

Addresses-Spec: https://review.openstack.org/#/c/437175/
Change-Id: I0d3fa68be351177af39228d34c682f48f75ac10d
2017-04-24 16:21:54 -07:00
Catherine Diep
293c207052 Re-organize RefStack document links
Also remove the specs links from the developer document links.

Change-Id: I9726c7a471ff577a2c3336b12f47ae9ac9d50b9e
2017-04-24 15:36:24 -07:00
Andreas Jaeger
0d29e9a144 Use openstackdocstheme
Since refstack is an official OpenStack project that gets published on
docs.openstack.org, it should use OpenStack branding.

Use openstackdocstheme and set it up correctly.

Change-Id: Iefce329a5ce85b90528045004356b065101b606b
2017-04-05 13:34:12 +02:00
Luz Cazares
057c7c2f11 Added sphnix build folder location
Added sphnix build folder location. Added Ocata implemented specs.
Fix registered sign character.

Change-Id: I27a8db968dbb029f370f46b77f3d2be1d85a45ca
2017-03-21 15:53:30 +00:00
Luz Cazares
f1ed8079ec Added tox target which checks requirements.txt
New tox target check that there is no missing or superfluous (unused)
requirements in requirements.txt.

Patch is copy/paste from Iff37af95269c38e4d435a53a21e5d60e2c5a3fa8
which do the same for Tempest projec.

This change also includes the fixes to requirements.txt needed
to pass the new tests.

Change-Id: Id52c5b140647268525120373ac19a63f72b12462
2017-02-14 21:58:43 +00:00
Monty Taylor
165e1877c7 Replace mention of easy_install with pip
easy_install is insecure and should never be used.

Change-Id: I051b7d3554222a36ac0e7e77bbfb8481eae0ea14
2016-12-16 15:02:37 +02:00
Catherine Diep
b2ccf08b51 Add document describing the newly added vendor and product features
Change-Id: I556c9248014af278fe8de5d5387cec62c9609198
Co-Authored-By: Paul Van Eck <pvaneck@us.ibm.com>
2016-12-08 13:31:36 -08:00
maliki
760ff1f255 Fix invalid and duplicate links
This commit fixes the invalid openstackid
links to fremontlabs as the repo doesnt
exist on github. The openstackid links
were given twice so fixed that too.

Change-Id: Idef191a45ba237eed0599352f662db2a18a23f66
2016-10-12 23:30:51 -07:00
David Lenwell
1ad26cbd71 Fixing some alignment issues in the quickstart instructions
Sections of of the quickstart documentation were written by different
developers at different times and have some formatting descrepencies
that make it hard to read.

Over use of bullet points durring instructions and commands have been
removed.

Change-Id: Ibab6bae2ab77e0408ba482cbee492f0f29aa7894
2016-09-02 15:35:10 -07:00
Simeon Monov
91ab6dd29d Add missing dependencies for Ubuntu 14/16
Added missing dependencies for Ubuntu 14 (libffi-dev) and
new dependencies for Ubuntu 16 (build-essential). Also
added new, optional section for building the documentation.

Change-Id: I181cd40c4b082c41367522a58d26fd587f73d31c
2016-08-25 15:27:33 +02:00
Simeon Monov
907777284b Update documentation to install Node.js v4
Current documentation installs Node.js v0.10 which will be deprecated
and cease support on Oct 1st, 2016. It is strongly recommended to
update to new version as soon as possible.

This patch changes the documentation to install Node.js v4 which is
the latest LTS release.

Change-Id: I869da86fc791d2e210ccb950b9f4679f21b20c9b
2016-08-24 00:59:23 +02:00
Atsushi SAKAI
359f3aa329 Fix two typos
rebuids  => rebuilds
agrument => argument

Change-Id: Ia0b4774c8d72c3aa02b10039d7163db66ae49d85
2016-08-23 19:38:39 +09:00
Luz Cazares
6b5b867bdc Adding mechanism to build documentation via sphinx
Change-Id: Iaf1b201ddb6890199dd76ab67022557b7fd0b2fc
2016-08-15 15:11:10 +00:00