docs

docs copied to clipboard

DebOps T-Shirt design

6

Should include: - Name of the Project and URL: "DebOps.org" - Logo - Slogan: Your Debian-based data center in a box A collection of Ansible playbooks, scalable from one container...

ypid

Code of conduct

2

Refs: - http://dancerscode.com/blog/why-the-open-code-of-conduct-isnt-for-me/ - http://contributor-covenant.org/ - https://github.com/QubesOS/qubes-issues/issues/2163 Status: The [Code of conduct of Qubes OS](https://www.qubes-os.org/code-of-conduct/) can be evaluated. See also: https://github.com/QubesOS/qubes-issues/issues/2163

ypid

Review pages where ansible_ssh_user is still in use

20

Since Ansible 2.0 and higher where `ansible_ssh_user` is deprecated and replaced by `ansible_user` [tallandtree_] Search: https://docs.debops.org/en/latest/search.html?q=ansible_ssh_user&check_keywords=yes&area=default

AnBuKu

Links in docs.debops.org often point to github instead of docs.debops.org

1

In [DebOps documentation](https://docs.debops.org/en/latest/index.html) links are very often linked to a DebOps page in [GitHub](https://github.com/debops/). This due to the fact, that they are done via `.rst` references. For readers of the...

AnBuKu

If something is unclear, update it in the docs directly instead of posting it somewhere on the Internet :)

7

Questions are arising from time to time on Reedit, GitHub, the DebOps mailing lists, IRC and multipel other places. If the answer to the questions might also benefit other users...

ypid

Unified sections and Vim folds.

8

Edit: Approved format: https://github.com/ypid/yaml2rst/blob/feature/yaml-fold-strip/examples/fold-markers-debops.yml Edit: Reasoning docs: https://github.com/ypid/yaml2rst/blob/feature/yaml-fold-strip/docs/fold-markers.rst Proposal for new unified sections and Vim folds format: Edit: Initial proposal: https://github.com/ypid/ypid-ansible-common/blob/47b0c3fbc3a59b78d3505016928fc209694cea0b/template_role/defaults/main.yml (has been redesigned by @drybjed, see https://github.com/debops/docs/issues/156#issuecomment-231670793) Refer to:...

ypid

Create converter script for unified sections and Vim folds.

1

Implements: #156 I plan to do this in Python3. The script should be idempotent and update `defaults/mail.yml` to the latest docs standards. Script name: `yaml4rst`. ~~ETA maybe 1 week from...

ypid

As DebOps has Debian as one of its role models, we should also setup something similar to https://onion.debian.org/ :wink: Proposed URL: https://onion.debops.org Depends: Some role to easily setup Tor Hidden...

ypid

DebOps logo - Status, requirements and re-desing/development

2

The [logo](https://en.wikipedia.org/wiki/Logo) is the visual/graphic design of DebOps. - **Status** The [actually used DebOps logo](https://debops.org/images/debops.png) is a graphic design **without** brand name/trademark name **DebOps**. Very likely it's a fork/revised version...

AnBuKu

Use global link definitions.

4

TL;DR https://github.com/debops/docs/blob/master/docs/includes/global.rst gets injected into all role docs when the `includes` directory is present. The `global.rst` should not be in role repos itself (and ignored using the `.gitignore` file). To...

ypid