From d39330c1bf2ab2335e557e100fa496b55defc714 Mon Sep 17 00:00:00 2001 From: Webster Mudge Date: Wed, 27 Aug 2025 16:33:46 -0400 Subject: [PATCH] Add docsite configuration Signed-off-by: Webster Mudge --- docs/docsite/config.yml | 30 ++++++++++++++++++++++++++++++ docs/docsite/extra-docs.yml | 20 ++++++++++++++++++++ docs/docsite/links.yml | 26 ++++++++++++++++++++++++++ 3 files changed, 76 insertions(+) create mode 100644 docs/docsite/config.yml create mode 100644 docs/docsite/extra-docs.yml create mode 100644 docs/docsite/links.yml diff --git a/docs/docsite/config.yml b/docs/docsite/config.yml new file mode 100644 index 00000000..c584a3ac --- /dev/null +++ b/docs/docsite/config.yml @@ -0,0 +1,30 @@ +# Copyright 2025 Cloudera, Inc. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +--- + +# Whether the collection uses flatmapping to flatten subdirectories in +# `plugins/*/`. +flatmap: true + +# List of environment variables that are defined by `.. envvar::` directives +# in the extra docsite RST files. +envvar_directives: [] + +# Changelog configuration (added in antsibull-docs 2.10.0) +changelog: + # Whether to write the changelog (taken from changelogs/changelog.yaml, see the + # antsibull-changelog documentation for more information) and link to it from the + # collection's index page. + write_changelog: true diff --git a/docs/docsite/extra-docs.yml b/docs/docsite/extra-docs.yml new file mode 100644 index 00000000..1ee87855 --- /dev/null +++ b/docs/docsite/extra-docs.yml @@ -0,0 +1,20 @@ +# Copyright 2025 Cloudera, Inc. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +--- + +# sections: +# - title: Guides +# toctree: +# - design.md diff --git a/docs/docsite/links.yml b/docs/docsite/links.yml new file mode 100644 index 00000000..77e5fdeb --- /dev/null +++ b/docs/docsite/links.yml @@ -0,0 +1,26 @@ +# Copyright 2025 Cloudera, Inc. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +--- + +edit_on_github: + repository: cloudera-labs/cloudera.exe + branch: main + path_prefix: "" + +extra_links: + - description: Submit a Bug Report + url: https://github.com/cloudera-labs/cloudera.exe/issues/new?labels=bug + - description: Request a Feature + url: https://github.com/cloudera-labs/cloudera.exe/issues/new?labels=enhancement