From 6ef3607769b184c4a49dbf386b454aaa264ae481 Mon Sep 17 00:00:00 2001 From: Pankaj Date: Thu, 27 Jun 2024 18:44:09 +0530 Subject: [PATCH] Restruct docs --- CODE_OF_CONDUCT.md | 128 ---------------------------- CHANGELOG.rst => docs/CHANGELOG.rst | 0 docs/CONTRIBUTING.rst | 2 +- docs/conf.py | 6 +- docs/index.rst | 7 +- 5 files changed, 3 insertions(+), 140 deletions(-) delete mode 100644 CODE_OF_CONDUCT.md rename CHANGELOG.rst => docs/CHANGELOG.rst (100%) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index b3378c6..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,128 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socioeconomic status, -nationality, personal appearance, race, religion, or sexual identity -and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -* Focusing on what is best not just for us as individuals, but for the - overall community - -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or - advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email - address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. -Examples of representing our community include using an official e-mail address, -posting via an official social media account, or acting as an appointed -representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -humans@astronomer.io. -All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series -of actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or -permanent ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within -the community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct/. - -Community Impact Guidelines were inspired by [Mozilla's code of conduct -enforcement ladder](https://github.com/mozilla/inclusion). - -[homepage]: https://www.contributor-covenant.org/ - -For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq/. Translations are available at -https://www.contributor-covenant.org/translations/. diff --git a/CHANGELOG.rst b/docs/CHANGELOG.rst similarity index 100% rename from CHANGELOG.rst rename to docs/CHANGELOG.rst diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst index 407818e..f682d62 100644 --- a/docs/CONTRIBUTING.rst +++ b/docs/CONTRIBUTING.rst @@ -3,7 +3,7 @@ Contributions Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. -Please note that this project is released with a `Contributor Code of Conduct <./CODE_OF_CONDUCT>`_. +Please note that this project is released with a `Contributor Code of Conduct <./docs/CODE_OF_CONDUCT>`_. By participating in this project you agree to abide by its terms. Overview diff --git a/docs/conf.py b/docs/conf.py index 3a87bcb..90b0397 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -8,7 +8,7 @@ project = "astro-provider-anyscale" copyright = "2024, Astronomer" -author = "Venkata Jagannath" +author = "Astronomer" release = "1.0.0" # -- General configuration --------------------------------------------------- @@ -30,8 +30,4 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = "pydata_sphinx_theme" -html_static_path = ["_static"] -html_css_files = [ - "css/custom.css", -] html_title = "astro-provider-anyscale" diff --git a/docs/index.rst b/docs/index.rst index d031f1d..93012fa 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,3 @@ -.. astro-provider-anyscale documentation master file, created by - sphinx-quickstart on Mon Jun 24 15:32:37 2024. - You can adapt this file completely to your liking, but it should at least - contain the root ``toctree`` directive. - Welcome to astro-provider-anyscale's documentation! =================================================== @@ -94,7 +89,7 @@ Changelog --------- We follow `Semantic Versioning `_ for releases. -Check `CHANGELOG.rst `_ +Check `CHANGELOG.rst `_ for the latest changes. License