Commit Graph

32 Commits

Author SHA1 Message Date
Ghanshyam Mann 0b8fba577f [ussuri][goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

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

Story: #2007236
Task: #38524
Change-Id: I79d513ce982dcaa9196371d89e326570998e08fd
2021-06-02 15:49:45 +00:00
Manpreet Kaur e41b382afd Dropping explicit unicode literal
In python 3, all strings are considered as unicode string.

This patch drops the explicit unicode literal (u'...')
or (u"..") appearances from the unicode strings.

Change-Id: Iaa040f10028935782d8315efc81d344e72b2a152
2021-01-30 13:57:04 +05:30
Andreas Jaeger 92efac6413 Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Ia9d81ddc1f3234af352787363e2963f808dbbad0
2020-05-30 17:10:51 +02:00
Andreas Jaeger 2ceec3b348 [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Increase requests lower requirement since oslo.config needs 2.18.0.
Fix idna lower-constraint to satisfy requests.

Change-Id: I753e09613b50e099060e2c85eb80d06d8b257858
2020-02-04 21:02:09 +01:00
pengyuesheng 25945f4363 Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: Iaad0471ba92a01494dca3c60522358fbbd3ceb86
2019-08-16 09:16:42 +08:00
pengyuesheng 57ff1f98ca Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: I7d8ef1469e329a945f38fa15498d440e82f0c209
2019-07-30 17:03:49 +08:00
Nguyen Hai 17aedacea5 Follow the new PTI for document build
Reference:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: I32256af5d8530435321e84f5dd19d8a9ce57840a
2018-05-30 15:02:54 +09:00
Nguyen Hai 060361fb11 Switch from oslosphinx to openstackdocstheme
- Change to openstackdocstheme which is a theme and extension
support for Sphinx documentation that is published to
docs.openstack.org and developer.openstack.org.
- This patch also updates README.rst

Change-Id: I5922eb9b0f5835be65a5ba3eead78bdf92458452
2018-05-29 19:43:49 +09:00
melissaml af19e0531f 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: I6a351a4468fa28d31de513b32ce95a35d209cc38
2018-04-21 18:39:59 +08:00
sahdev zala af2410f3aa Update doc
Update doc to brief about newly added API to access nested templates,
programatically and via CLI.

Change-Id: If6b0afb7796b76f909714d2833a33974382ca005
2017-01-12 16:29:57 -05:00
gengchc2 32d5aa3c38 Removes unnecessary utf-8 coding
The file was added redundant utf-8 coding by some editor.
we can delete it .

Change-Id: Ib34ed8935d29ed0d39f0981e4d880106840baece
2016-12-26 14:47:11 +08:00
sahdev zala 5571a65aac Doc update for autoscaling translation support
Update usage document for the Senlin and AutoScalingGroup translation support
in the Heat Translator.

Change-Id: I0bf992f342684871027a18b146f6f2eb22c9ea86
2016-11-14 16:14:50 -05:00
Yushiro FURUKAWA 3bf08656c0 Trivialfix: 'yaml' to 'YAML'
Change-Id: Ib206beee210a8d9701b95b2cd6a20757ea66152e
2016-09-30 22:55:04 +09:00
Sahdev Zala d591dfa076 Doc update on automatically deploying template
Document the usage of heat-translator to automatically deploy translated
TOSCA template.

Change-Id: I102e35f64830af26c914f3bbd202b43d817f1fac
2016-09-21 14:35:16 -07:00
Sahdev Zala a331dfadfe The —template-type is no longer required arg
The translator by default uses tosca as a value to the --template-type arg.
The --template-type arg which used to be a required arg is an optional arg and
needs to be reflected in the doc.

Change-Id: Idb9da528ea9e08c331e554c0167ac449f9f9a6e3
Closes-Bug: #1610581
2016-08-06 12:08:10 -07:00
Sahdev Zala ef6435024a Doc update
Document how translator project sets flavor and image in the translated template
for the TOSCA Compute node host and os capabilities constraints.

Change-Id: Ib4cf18c2056fe118d6a4312d2ec4e6e1f85a8889
2016-04-21 14:52:46 -07:00
Sahdev Zala 99c3bda42e Doc update
Document how flavor and image properties can be used in the TOSCA template.

Change-Id: Ie91ee9d647257aa8db5261ab19f802ab3e904cda
Closes-Bug: 1552069
2016-03-01 20:06:03 -08:00
Sahdev Zala 5ca236d44b Update doc
Update doc to reflect some of the latest implementations.

Co-Authored-By: Brad Topol <btopol@us.ibm.com>
Change-Id: I23c9c11d3295bd32531d51e0266ea705b58f12ef
Closes-Bug: 1550447
2016-02-26 10:37:44 -08:00
Jenkins ab4979a816 Merge "Provide an option to store translated output in a file" 2015-12-17 22:19:59 +00:00
spzala 60d90fc9ff Provide an option to store translated output in a file
It can be very helfpul for user to have translated content stored in a
desired file. A new optional arg --output-file is created herewith.

Change-Id: Ic0cbc4eb4e8701bf8aff663b66d44a8fced2ed88
2015-12-17 01:24:07 -08:00
spzala 7b2d647d06 Update usage documentation
A new command line arg for template validation is added and documentation
needs to be updated accordingly.

Change-Id: I7e2c6c4376198b723ea89872320f9c3687621b9b
Implements: blueprint template-validation-only
2015-12-16 20:26:55 -08:00
spzala 50f6aa328c Update documentation to cover new features
Update documentaton for CSAR and pypi install.

Change-Id: Id23b0bbb07e21a7cf0f332c38bacd751a2328600
Co-Authored-By: Vahid Hashemian <vahidhashemian@us.ibm.com>
2015-10-02 19:04:58 -07:00
spzala b4824100a5 Update doc references
Update doc to remove toscalib references. Completing the work to remoev TOSCA
code from heat-translator herewith.

Change-Id: I6a36b443ea60ed9944caa05f0368623923715425
Implements: blueprint use-tosca-parser-library
2015-09-11 06:35:46 -07:00
Atsushi SAKAI 36f7f6a18c Fix two typos on heat-translator documentation
Transalator => Translator
hellow => hello

Change-Id: I17326a6977b061e15c45988658fc52b06d03ed38
Closes-Bug: #1481168
2015-08-04 14:13:14 +09:00
spzala 84dda44e8b Update TOSCA translator installation doc
Provide detail of how heat translator can be installed currently.

Change-Id: I1f8fb44f259262f1788815b404a9c5709f1380af
2015-07-08 08:22:53 -07:00
spzala 2f9040ba8e Document usage of translator with OSC
Update usage information for heat-translator OSC plugin

Change-Id: I7baf0d6108cf46c63cb8550405a3a9940dbee571
2015-07-07 09:51:41 -07:00
spzala 3a10532067 TOSCA: Create a test CLI program
This program provide a good usage to test the Heat-Translator tool on the
command line with expection of similar usage via Heat python client in near
future. The TOSCA hello world use case is implemented for quick testing
as well.

implements blueprint tosca-translator-cli-test-utility

Change-Id: Ia4ddf65aafcbe440ea9551ccc2648de4a7c88c97
2015-05-11 09:25:30 -07:00
Steve Martinelli bf87dbfa62 Update heat-translator's documentation theme
Use the theme that is bundled with oslosphinx to create a more
'openstack' themed documentation site.

Change-Id: Iaeb9aed5fc7e1f0dd78ff847dbcb70a624e944f9
2015-04-27 12:19:34 -04:00
spzala be9551b5a1 Update README and other doc files
README needs more information and update on project info.

Change-Id: Ic409253d76903535fb89f15765204d46d2153f02
Closes-Bug: #1363139
2014-08-29 09:02:30 -07:00
Steve Martinelli 175af0fe58 Clean up heat-translator documentation
Several RST formatting errors, added some more content too.

Change-Id: I44a557398e668152c38ddad07c01ea6cd38b65ea
2014-08-28 11:41:15 -04:00
Steve Martinelli 2f9f244b29 Revert use of olsosphinx library
Use the default theme since the projects under stackforge should
not be using the openstack brand, and oslosphinx extensions when
building documentation

Change-Id: I075f3ec3524a85ceabd228dc8085752e9f608b42
2014-08-28 11:34:45 -04:00
Sahdev Zala d4d826ef96 Add .gitreview file and apply cookiecutter template.
Add .getreview file and add files generated via cookiecutter template.
Also delete some originally added files to have project's initial layout
ready.

Change-Id: I494f52469b5a4aff1c1f12d58bcf41140ad3e680
2014-04-01 09:43:50 -05:00