<feed xmlns='http://www.w3.org/2005/Atom'>
<title>vyos-cloud-init.git/doc/rtd/conf.py, branch rolling</title>
<subtitle> (mirror of https://github.com/vyos/vyos-cloud-init.git)
</subtitle>
<id>https://git.amelek.net/vyos/vyos-cloud-init.git/atom?h=rolling</id>
<link rel='self' href='https://git.amelek.net/vyos/vyos-cloud-init.git/atom?h=rolling'/>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-cloud-init.git/'/>
<updated>2022-02-02T21:21:00+00:00</updated>
<entry>
<title>spell check docs with spellintian (#1223)</title>
<updated>2022-02-02T21:21:00+00:00</updated>
<author>
<name>Brett Holman</name>
<email>bholman.devel@gmail.com</email>
</author>
<published>2022-02-02T21:21:00+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-cloud-init.git/commit/?id=7522845dfe8851b7b4f3e9924810b9ccf282bb6e'/>
<id>urn:sha1:7522845dfe8851b7b4f3e9924810b9ccf282bb6e</id>
<content type='text'>
Fix spelling errors

- Add Makefile target that checks for spelling errors
- Add Makefile target that fixes spelling errors
- Add spelling check to travis doc tests
- Fix various spelling errors in the docs </content>
</entry>
<entry>
<title>Adopt Black and isort (SC-700) (#1157)</title>
<updated>2021-12-16T02:16:38+00:00</updated>
<author>
<name>James Falcon</name>
<email>james.falcon@canonical.com</email>
</author>
<published>2021-12-16T02:16:38+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-cloud-init.git/commit/?id=bae9b11da9ed7dd0b16fe5adeaf4774b7cc628cf'/>
<id>urn:sha1:bae9b11da9ed7dd0b16fe5adeaf4774b7cc628cf</id>
<content type='text'>
Applied Black and isort, fixed any linting issues, updated tox.ini
and CI.
</content>
</entry>
<entry>
<title>Add Strict Metaschema Validation (#1101)</title>
<updated>2021-12-06T22:27:12+00:00</updated>
<author>
<name>Brett Holman</name>
<email>bholman.devel@gmail.com</email>
</author>
<published>2021-12-06T22:27:12+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-cloud-init.git/commit/?id=bedac77e9348e7a54c0ec364fb61df90cd893972'/>
<id>urn:sha1:bedac77e9348e7a54c0ec364fb61df90cd893972</id>
<content type='text'>
Improve schema validation.

This adds strict validation of config module definitions at testing
time, with plumbing included for future runtime validation. This
eliminates a class of bugs resulting from schemas that have definitions
that are incorrect, but get interpreted by jsonschema as
"additionalProperties" that are therefore ignored.

- Add strict meta-schema for jsonschema unit test validation
- Separate schema from module metadata structure
- Improve type annotations for various functions and data types

Cleanup:
- Remove unused jsonschema "required" elements 
- Eliminate manual memoization in schema.py:get_schema(),
        reference module.__doc__ directly</content>
</entry>
<entry>
<title>doc/rtd/conf.py: bump copyright year to 2020 (#341)</title>
<updated>2020-04-30T17:16:00+00:00</updated>
<author>
<name>Daniel Watkins</name>
<email>oddbloke@ubuntu.com</email>
</author>
<published>2020-04-30T17:16:00+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-cloud-init.git/commit/?id=0a4971b2b2d073bc96786baf8a050b0c411e1c39'/>
<id>urn:sha1:0a4971b2b2d073bc96786baf8a050b0c411e1c39</id>
<content type='text'>
</content>
</entry>
<entry>
<title>docs: Add security.md to readthedocs</title>
<updated>2019-12-06T20:41:39+00:00</updated>
<author>
<name>Joshua Powers</name>
<email>josh.powers@canonical.com</email>
</author>
<published>2019-12-06T20:41:40+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-cloud-init.git/commit/?id=bbd9ef9f5dc9b3728d0d10534bf5d8b372bd1641'/>
<id>urn:sha1:bbd9ef9f5dc9b3728d0d10534bf5d8b372bd1641</id>
<content type='text'>
* docs: Add security.md to readthedocs

This enables the ability to show the security policy on both GitHub and
on the readthedocs site. To do this, enable the ability to import
Markdown based files and translate them to rst.

* Add doc-requirements.txt and update tox to use

Also removes the extra, uncessary extension addition of .md
</content>
</entry>
<entry>
<title>doc: document doc, create makefile and tox target</title>
<updated>2019-09-07T02:27:45+00:00</updated>
<author>
<name>Joshua Powers</name>
<email>josh.powers@canonical.com</email>
</author>
<published>2019-09-07T02:27:45+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-cloud-init.git/commit/?id=385232dc8da6532b54342cd11e6d822ff7cd3e5a'/>
<id>urn:sha1:385232dc8da6532b54342cd11e6d822ff7cd3e5a</id>
<content type='text'>
* Create makefile and tox targets for documentation building and testing
to better replicate the live web docs using the same theme.
* Created docs.rst to explain how to build and contribute to documentation
with style guide and tips.
* doc/rtd/conf.py:
    * Add copyright to rtd config
    * Use Sphinx's RTD theme to replicate actual docs
</content>
</entry>
<entry>
<title>doc: remove intersphinx extension</title>
<updated>2019-08-08T15:27:57+00:00</updated>
<author>
<name>Daniel Watkins</name>
<email>daniel.watkins@canonical.com</email>
</author>
<published>2019-08-08T15:27:57+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-cloud-init.git/commit/?id=6718b86e3e742f4ed4e39c3766ded2273128409c'/>
<id>urn:sha1:6718b86e3e742f4ed4e39c3766ded2273128409c</id>
<content type='text'>
We don't use it in our doc builds, and if sphinx.pocoo.org is down then
it causes doc build issues.
</content>
</entry>
<entry>
<title>cc_snap: Add new module to install and configure snapd and snap packages.</title>
<updated>2018-03-16T19:43:31+00:00</updated>
<author>
<name>Chad Smith</name>
<email>chad.smith@canonical.com</email>
</author>
<published>2018-03-16T19:43:31+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-cloud-init.git/commit/?id=a1f678f8ebc080d4737f32275f42947b84ae025a'/>
<id>urn:sha1:a1f678f8ebc080d4737f32275f42947b84ae025a</id>
<content type='text'>
Support installing and configuring snaps on ubuntu systems. Now,
cloud-config files can provide a list or dictionary of snap:assertions
which will be allow configuration of snapd on a system via 'snap ack'
calls. The snap:commands configuration option supports arbitrary system
commands intended to interact with snappy's cli. This allows users to run
arbitrary snappy commands to create users, download, install and
configure snap packages and snapd.

This branch also deprecates old snappy and snap_config modules leaving
warnings in documentation and runtime for consumers of these modules.
Deprecated snap* modules will be dropped in cloud-init v.18.2 release.
</content>
</entry>
<entry>
<title>docs: Automatically generate module docs form schema if present.</title>
<updated>2017-06-15T19:09:41+00:00</updated>
<author>
<name>Chad Smith</name>
<email>chad.smith@canonical.com</email>
</author>
<published>2017-06-12T16:39:20+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-cloud-init.git/commit/?id=1025e492412431e95b7ddde46805514e42469db0'/>
<id>urn:sha1:1025e492412431e95b7ddde46805514e42469db0</id>
<content type='text'>
We have started adding jsonschema definitions for cloudconfig modules
(cc_ntp). This branch allows us render sphinx docs using the module's
shema definition instead of using the module's docstring.

This allows us to avoid duplicating schema documentation in the
module-level docstring and schema definition. The corresponding module
documentation is extended a bit to differentiate between config schema and
potential examples.
</content>
</entry>
<entry>
<title>Improve module documentation and doc cleanup.</title>
<updated>2016-09-30T17:21:00+00:00</updated>
<author>
<name>Wesley Wiedenmeier</name>
<email>wesley.wiedenmeier@gmail.com</email>
</author>
<published>2016-08-28T22:56:17+00:00</published>
<link rel='alternate' type='text/html' href='https://git.amelek.net/vyos/vyos-cloud-init.git/commit/?id=1071b9940b4e114cd2eabf290b739f92fbab33de'/>
<id>urn:sha1:1071b9940b4e114cd2eabf290b739f92fbab33de</id>
<content type='text'>
This adds lots of config module documentation in a standard format.
It will greatly improve the content at readthedocs.
Additionally:
 * Add a 'doc' env to tox.ini
 * Changed default highlight language for sphinx conf from python to yaml
   most examples in documentation are yaml configs
 * Updated datasource examples to highlight sh code properly
</content>
</entry>
</feed>
