From 65211fed1854b548ece60deaad3a7315855e0d24 Mon Sep 17 00:00:00 2001 From: Balaaditya Patanjali <138308724+BalaadityaPatanjali@users.noreply.github.com> Date: Thu, 27 Jun 2024 14:02:06 +0530 Subject: [PATCH] docs: updated contribution guidelines for website (#3559) Signed-off-by: BalaadityaPatanjali Signed-off-by: odubajDT <93584209+odubajDT@users.noreply.github.com> Co-authored-by: RealAnna <89971034+RealAnna@users.noreply.github.com> Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com> --- docs/docs/contribute/index.md | 6 +++++ docs/docs/contribute/website/index.md | 35 +++++++++++++++++++++++++++ docs/website.yml | 10 ++++++++ mkdocs.yml | 2 ++ 4 files changed, 53 insertions(+) create mode 100644 docs/docs/contribute/website/index.md create mode 100644 docs/website.yml diff --git a/docs/docs/contribute/index.md b/docs/docs/contribute/index.md index 28f51d60c5..9cd285a7a8 100644 --- a/docs/docs/contribute/index.md +++ b/docs/docs/contribute/index.md @@ -36,3 +36,9 @@ It is divided into three sections: gives additional guidelines that apply only to documentation contributions and describes the documentation file structure and the documentation tools we use. + +* [Website contributions](website/index.md) + provides relevant information for contributing + to the website, including all the file directories and + files used to modify the website, and instructions for + testing and verifying changes before submitting. diff --git a/docs/docs/contribute/website/index.md b/docs/docs/contribute/website/index.md new file mode 100644 index 0000000000..db7e06c9c3 --- /dev/null +++ b/docs/docs/contribute/website/index.md @@ -0,0 +1,35 @@ +--- +comments: true +--- + +# Contribute to the Website + +This section provides information on how to contribute to the website. + +## Location of Files Used to Modify the Website + +Here are some key files and directories: + +- **`docs/assets/`**: This directory contains all the stylesheets and +javascript files. +- **`docs/overrides/`**: This directory contains all the html files. +- **`docs/website.yml`**: This file contains configurations specific to the +website, such as all the directories. +- **`mkdocs.yml`**: The main configuration file for MkDocs. +It defines the structure and configuration of the documentation site. + +## How to Test/Verify Changes + +To test and verify changes before submitting: + +- Make your changes in a new branch. +- Open a pull request. +- The changes will be reflected in the ReadTheDocs preview for the PR. +- Review the preview to ensure your changes are correct. + +## Building the Website Locally + +To see your changes live on your local machine, follow the steps described in the +[Building Documentation Locally](../docs/local-building.md) guide. +This guide provides detailed instructions on how to set up a local MkDocs build +environment. diff --git a/docs/website.yml b/docs/website.yml new file mode 100644 index 0000000000..59adbca723 --- /dev/null +++ b/docs/website.yml @@ -0,0 +1,10 @@ +contribution_guide: + directories: + website_files: + HTML_files: + - first_path: "https://github.com/keptn/lifecycle-toolkit/tree/main/docs/overrides" + - second_path: "https://github.com/keptn/lifecycle-toolkit/tree/main/docs/overrides/partials" + stylesheet_files: + - path: "https://github.com/keptn/lifecycle-toolkit/tree/main/docs/assets/stylesheets" + javascript_files: + - path: "https://github.com/keptn/lifecycle-toolkit/tree/main/docs/assets/javascripts" diff --git a/mkdocs.yml b/mkdocs.yml index 7ef9cdbc61..879b7bbe4b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -234,5 +234,7 @@ nav: - Blogs: docs/contribute/docs/blog.md - Published doc structure: docs/contribute/docs/publish.md - Word list: docs/contribute/docs/word-list.md + - Website Contributions: + - docs/contribute/website/index.md - Blog: - blog/index.md