openvox-docs/source/_config.yml at ef1ab368e9c69bdd00c8e17cc6f06f702e8d2255 · OpenVoxProject/openvox-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
---
highlighter: none
markdown: kramdown
kramdown:
  input: GFM
  hard_wrap: false
url: "https://puppet.com/docs"
safe: false
# YAML frontmatter defaults:
defaults: [ {scope: {path: ""},
             values: {layout: "default",
                      toc_levels: "23",
                      nav: "/_includes/fallback_nav.html"} } ]
defaultnav:
  /background/ssl: /_includes/background_ssl.html
  /security: /security/_security_toc.html
  /community: /_includes/community_nav.html
  /forge: /_includes/forge.html
  /de: /_includes/de_pe.html
  /es: /_includes/es_docs.html
  /es/hiera: /_includes/es_hiera1.html
  /es/learning: /_includes/es_learning_nav.html
  /es/pe/3.8: /_includes/es_pe38.html
  /es/puppet: /_includes/_es_fallback_nav.html
  /learning: /_includes/learning_nav.html
  /mcollective: /_includes/mcollective_menu.html
  /mcollective1.2: /_includes/mcollective_1.2.html
  /upgrade: /upgrade/_upgrade_toc.html

# Anatomy of an external source:
#  /puppetdb/2.2:                                   # The absolute URL where the source's contents should be mounted in the final site.
#    repo: git://github.com/puppetlabs/puppetdb.git # The URL of the upstream repo, in any form `git clone` understands. This must be accessible to anyone who will need to build the site.
#    commit: origin/2.2.x                           # A git treeish (in any form `git checkout` understands) that the external source should track. This should almost always be either a tag, which will never update, or an upstream tracking branch on the default "origin" remote (origin/<branch>), which will update every time someone builds the site.
#    subdirectory: documentation                    # A subdirectory within the remote repository that contains the documentation files that we'll build and mount at the specified url.
externalsources:
  /mcollective:
    repo: https://github.com/choria-legacy/marionette-collective.git
    commit: origin/2.12.x
    subdirectory: website


# symlink_latest:
#  - puppet
#  - puppetdb
#  - puppetserver
#  - hiera
#  - facter
#  - pdk
#  - pe
#  - ja/pe
#  - es/puppet
# lock_latest:


document_names:
  pe: Puppet Enterprise
  puppet: Puppet
  puppetserver: Puppet Server
  puppetdb: PuppetDB
  facter: Facter
  pdk: Puppet Development Kit

# Anatomy of a document:
#  /pe/2015.3:                    # Base URL for this doc, starting from the root of the site.
#    doc: pe                      # Which document group it's a part of. Used to determine this doc's siblings.
#    version: 2015.3              # Version. Used for associating confirmed version numbers with a URL.
#    nav: ./_pe_toc.html          # Nav snippet. Can be an absolute URL, or relative to the base URL.
#    hide: false                  # Whether to hide this version in the version switcher. Optional; defaults to false.
#    draft: false                 # Whether to warn in the version note that this is a draft for an unreleased version. Optional; defaults to false.
#    external_source:             # External source. (See Anatomy of an external source, above.) Optional; if absent, we use content from this repo instead of an external repo.
#      repo: git@github.com:puppetlabs/pe-docs-private.git   # A git repo
#      commit: origin/pe2015.3.1
#      subdirectory: source
#    my_versions:                 # A hash, where you can specify the most-relevant version for any number of other documents.
#      puppet: "4.3"                # The keys of this hash should be document group IDs; that is, the value of the `doc` key from another document.
#      facter: "3.1"
#      hiera: "3.0"
#      puppetserver: "2.2"
#      puppetdb: "3.2"

documents:
  # PDK
  /pdk/1.0:
    doc: pdk
    version: "1.0"
    nav: ./_pdk_toc.html
    hide: true

  # PuppetDB
  /puppetdb/latest:
    doc: puppetdb
    version: "latest"
    nav: ./_puppetdb_nav.html
    external_source:
      repo: https://github.com/OpenVoxProject/openvoxdb
      commit: doc-latest
      subdirectory: documentation
    hide: true
  /puppetdb/7:
    doc: puppetdb
    version: "7"
    nav: ./_puppetdb_nav.html
    external_source:
      repo: https://github.com/OpenVoxProject/openvoxdb
      commit: doc-7.y
      subdirectory: documentation
    hide: true
  /puppetdb/6:
    doc: puppetdb
    version: "6"
    nav: ./_puppetdb_nav.html
    external_source:
      repo: https://github.com/OpenVoxProject/openvoxdb
      commit: doc-6.y
      subdirectory: documentation
    hide: true
  /puppetdb/5.2:
    doc: puppetdb
    version: "5.2"
    nav: ./_puppetdb_nav.html
    external_source:
      repo: https://github.com/OpenVoxProject/openvoxdb
      commit: doc-5.2
      subdirectory: documentation
    hide: true

  # Puppet latest
  /puppet/latest:
    doc: puppet
    version: "latest"
    nav: ./_puppet_toc.html

  # Puppet 6.y
  /puppet/6.y:
    doc: puppet
    version: "6.y"
    nav: ./_puppet_toc.html

  # Delete once 6.20 goes live
  /puppet/6.19:
    doc: puppet
    version: "6.19"
    nav: ./_puppet_toc.html

---