You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by "mark-imply (via GitHub)" <gi...@apache.org> on 2023/03/01 20:47:40 UTC
[GitHub] [druid] mark-imply opened a new pull request, #13868: Add docs contribution page
mark-imply opened a new pull request, #13868:
URL: https://github.com/apache/druid/pull/13868
Add guidance for contributing to Druid docs.
This PR has:
- [x] been self-reviewed.
- [ ] using the [concurrency checklist](https://github.com/apache/druid/blob/master/dev/code-review/concurrency.md) (Remove this item if the PR doesn't have any relation to concurrency.)
- [ ] added documentation for new or modified features or behaviors.
- [ ] a release note entry in the PR description.
- [ ] added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links.
- [ ] added or updated version, license, or notice information in [licenses.yaml](https://github.com/apache/druid/blob/master/dev/license.md)
- [ ] added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
- [ ] added unit tests or modified existing tests to cover new code paths, ensuring the threshold for [code coverage](https://github.com/apache/druid/blob/master/dev/code-review/code-coverage.md) is met.
- [ ] added integration tests.
- [ ] been tested in a test Druid cluster.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] techdocsmith closed pull request #13868: Add docs contribution page
Posted by "techdocsmith (via GitHub)" <gi...@apache.org>.
techdocsmith closed pull request #13868: Add docs contribution page
URL: https://github.com/apache/druid/pull/13868
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] techdocsmith commented on a diff in pull request #13868: Add docs contribution page
Posted by "techdocsmith (via GitHub)" <gi...@apache.org>.
techdocsmith commented on code in PR #13868:
URL: https://github.com/apache/druid/pull/13868#discussion_r1154986298
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
+
+## Contributing
+
+ 1. On branch ```master```, fetch the latest commit:
+
+ ~~~~
+ git fetch upstream
+
+ remote: Enumerating objects: 397, done.
+ remote: Counting objects: 100% (341/341), done.
+ remote: Compressing objects: 100% (181/181), done.
+ remote: Total 397 (delta 118), reused 255 (delta 98), pack-reused 56
+ Receiving objects: 100% (397/397), 266.19 KiB | 16.64 MiB/s, done.
+ Resolving deltas: 100% (118/118), completed with 44 local objects.
+ From https://github.com/apache/druid
+ 819d706082..6c9f926e3e 0.21.0 -> upstream/0.21.0
+ 8a3be6bccc..84aac4832d master -> upstream/master
+ * [new tag] druid-0.21.0 -> druid-0.21.0
+
+ ➜ git reset --hard upstream/master
+ HEAD is now at 84aac4832d Add feature to automatically remove rules based on retention period (#11164)
+ ~~~~
+
+ Now you're up to date.
+
+ 2. Create your working branch:
+ ~~~~
+ git checkout -b my-work
+ ~~~~
+ 3. Make your changes, add, and commit:
+ ~~~~
+ git add my-change.md
+ git commit -m "i made some changes"
+ ~~~~
+ 4. Test changes locally.
+ 5. Push your changes to your fork: ```origin```
+ ~~~~
+ git push --set-upstream origin my-work
+ ~~~~
+ 6. Go to GitHub for the Druid repo. It should realize you have a new branch in your fork. Create a pull request from your for ```my-work``` to ```master``` in the Druid repo.
+
+## Style guide
+
+Before publishing new content or updating an existing topic, audit your documentation using this checklist to make sure your contributions align with existing documentation.
+
+* Use descriptive link text. If a link downloads a file, make sure to indicate this action
+* Use present tense where possible
+* Avoid negative constructions when possible
+* Use clear and direct language
+* Use descriptive headings and titles
+* Avoid using a present participle or gerund as the first word in a heading or title
+* Use sentence case in document titles and headings
+* Don’t use images of text or code samples
+* Use SVG over PNG if available
+* Provide an equivalent text explanation with each image
+* Use the appropriate text-formatting
+* Put conditional clauses before instructions
+* Avoid gender-specific pronouns, instead use they
+* Use second person — you instead of we
+* When American spelling is different from Commonwealth/"British" spelling, use the American spelling
+* Don’t use terms considered disrespectful. Refer to the Google’s [Word list](https://developers.google.com/style/word-list) for guidance and alternatives
+* Use straight quotation marks and straight apostrophes
+* Introduce a list, a table, or a procedure with an introductory sentence
Review Comment:
@paul-rogers , can we not introduce this style now. None of the current docs follow it and I worry that it could cause confusion. For example, if someone were to edit an existing doc and use a line-breaking tool to fix their markdown, then it would possibly make the pr affect a lot more lines than they intend.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] paul-rogers commented on a diff in pull request #13868: Add docs contribution page
Posted by "paul-rogers (via GitHub)" <gi...@apache.org>.
paul-rogers commented on code in PR #13868:
URL: https://github.com/apache/druid/pull/13868#discussion_r1123433194
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
Review Comment:
Inquiring minds want to know...
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
Review Comment:
I'm not sure the above is needed. The way the repo is cloned above, there will be no reference to any repo other than your own, and you will want to push to that one. Also, these steps should be identical to that we explain for developers: https://druid.apache.org/docs/24.0.0/development/build.html
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
+
+## Contributing
+
+ 1. On branch ```master```, fetch the latest commit:
+
+ ~~~~
+ git fetch upstream
+
+ remote: Enumerating objects: 397, done.
+ remote: Counting objects: 100% (341/341), done.
+ remote: Compressing objects: 100% (181/181), done.
+ remote: Total 397 (delta 118), reused 255 (delta 98), pack-reused 56
+ Receiving objects: 100% (397/397), 266.19 KiB | 16.64 MiB/s, done.
+ Resolving deltas: 100% (118/118), completed with 44 local objects.
+ From https://github.com/apache/druid
+ 819d706082..6c9f926e3e 0.21.0 -> upstream/0.21.0
+ 8a3be6bccc..84aac4832d master -> upstream/master
+ * [new tag] druid-0.21.0 -> druid-0.21.0
+
+ ➜ git reset --hard upstream/master
+ HEAD is now at 84aac4832d Add feature to automatically remove rules based on retention period (#11164)
Review Comment:
No need to show the output: the command itself is good.
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
+
+## Contributing
+
+ 1. On branch ```master```, fetch the latest commit:
+
+ ~~~~
+ git fetch upstream
+
+ remote: Enumerating objects: 397, done.
+ remote: Counting objects: 100% (341/341), done.
+ remote: Compressing objects: 100% (181/181), done.
+ remote: Total 397 (delta 118), reused 255 (delta 98), pack-reused 56
+ Receiving objects: 100% (397/397), 266.19 KiB | 16.64 MiB/s, done.
+ Resolving deltas: 100% (118/118), completed with 44 local objects.
+ From https://github.com/apache/druid
+ 819d706082..6c9f926e3e 0.21.0 -> upstream/0.21.0
+ 8a3be6bccc..84aac4832d master -> upstream/master
+ * [new tag] druid-0.21.0 -> druid-0.21.0
+
+ ➜ git reset --hard upstream/master
+ HEAD is now at 84aac4832d Add feature to automatically remove rules based on retention period (#11164)
+ ~~~~
+
+ Now you're up to date.
+
+ 2. Create your working branch:
+ ~~~~
+ git checkout -b my-work
+ ~~~~
+ 3. Make your changes, add, and commit:
+ ~~~~
+ git add my-change.md
+ git commit -m "i made some changes"
+ ~~~~
+ 4. Test changes locally.
+ 5. Push your changes to your fork: ```origin```
+ ~~~~
+ git push --set-upstream origin my-work
+ ~~~~
+ 6. Go to GitHub for the Druid repo. It should realize you have a new branch in your fork. Create a pull request from your for ```my-work``` to ```master``` in the Druid repo.
+
+## Style guide
+
+Before publishing new content or updating an existing topic, audit your documentation using this checklist to make sure your contributions align with existing documentation.
+
+* Use descriptive link text. If a link downloads a file, make sure to indicate this action
+* Use present tense where possible
+* Avoid negative constructions when possible
+* Use clear and direct language
+* Use descriptive headings and titles
+* Avoid using a present participle or gerund as the first word in a heading or title
+* Use sentence case in document titles and headings
+* Don’t use images of text or code samples
+* Use SVG over PNG if available
+* Provide an equivalent text explanation with each image
+* Use the appropriate text-formatting
Review Comment:
What _is_ the appropriate text formatting?
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
+
+## Contributing
+
+ 1. On branch ```master```, fetch the latest commit:
+
+ ~~~~
+ git fetch upstream
+
+ remote: Enumerating objects: 397, done.
+ remote: Counting objects: 100% (341/341), done.
+ remote: Compressing objects: 100% (181/181), done.
+ remote: Total 397 (delta 118), reused 255 (delta 98), pack-reused 56
+ Receiving objects: 100% (397/397), 266.19 KiB | 16.64 MiB/s, done.
+ Resolving deltas: 100% (118/118), completed with 44 local objects.
+ From https://github.com/apache/druid
+ 819d706082..6c9f926e3e 0.21.0 -> upstream/0.21.0
+ 8a3be6bccc..84aac4832d master -> upstream/master
+ * [new tag] druid-0.21.0 -> druid-0.21.0
+
+ ➜ git reset --hard upstream/master
+ HEAD is now at 84aac4832d Add feature to automatically remove rules based on retention period (#11164)
+ ~~~~
+
+ Now you're up to date.
+
+ 2. Create your working branch:
+ ~~~~
+ git checkout -b my-work
+ ~~~~
+ 3. Make your changes, add, and commit:
+ ~~~~
+ git add my-change.md
+ git commit -m "i made some changes"
+ ~~~~
+ 4. Test changes locally.
Review Comment:
Generally, we should test _before_ we commit, just in case we have to fix anything.
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
+
+## Contributing
+
+ 1. On branch ```master```, fetch the latest commit:
+
+ ~~~~
+ git fetch upstream
+
+ remote: Enumerating objects: 397, done.
+ remote: Counting objects: 100% (341/341), done.
+ remote: Compressing objects: 100% (181/181), done.
+ remote: Total 397 (delta 118), reused 255 (delta 98), pack-reused 56
+ Receiving objects: 100% (397/397), 266.19 KiB | 16.64 MiB/s, done.
+ Resolving deltas: 100% (118/118), completed with 44 local objects.
+ From https://github.com/apache/druid
+ 819d706082..6c9f926e3e 0.21.0 -> upstream/0.21.0
+ 8a3be6bccc..84aac4832d master -> upstream/master
+ * [new tag] druid-0.21.0 -> druid-0.21.0
+
+ ➜ git reset --hard upstream/master
+ HEAD is now at 84aac4832d Add feature to automatically remove rules based on retention period (#11164)
+ ~~~~
+
+ Now you're up to date.
+
+ 2. Create your working branch:
+ ~~~~
+ git checkout -b my-work
+ ~~~~
+ 3. Make your changes, add, and commit:
+ ~~~~
+ git add my-change.md
+ git commit -m "i made some changes"
+ ~~~~
+ 4. Test changes locally.
+ 5. Push your changes to your fork: ```origin```
+ ~~~~
+ git push --set-upstream origin my-work
+ ~~~~
+ 6. Go to GitHub for the Druid repo. It should realize you have a new branch in your fork. Create a pull request from your for ```my-work``` to ```master``` in the Druid repo.
+
+## Style guide
+
+Before publishing new content or updating an existing topic, audit your documentation using this checklist to make sure your contributions align with existing documentation.
+
+* Use descriptive link text. If a link downloads a file, make sure to indicate this action
Review Comment:
Examples of each would be great. For example, _how_ should I indicate this action?
Nit: periods at the end of each line.
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
+
+## Contributing
+
+ 1. On branch ```master```, fetch the latest commit:
+
+ ~~~~
+ git fetch upstream
+
+ remote: Enumerating objects: 397, done.
+ remote: Counting objects: 100% (341/341), done.
+ remote: Compressing objects: 100% (181/181), done.
+ remote: Total 397 (delta 118), reused 255 (delta 98), pack-reused 56
+ Receiving objects: 100% (397/397), 266.19 KiB | 16.64 MiB/s, done.
+ Resolving deltas: 100% (118/118), completed with 44 local objects.
+ From https://github.com/apache/druid
+ 819d706082..6c9f926e3e 0.21.0 -> upstream/0.21.0
+ 8a3be6bccc..84aac4832d master -> upstream/master
+ * [new tag] druid-0.21.0 -> druid-0.21.0
+
+ ➜ git reset --hard upstream/master
+ HEAD is now at 84aac4832d Add feature to automatically remove rules based on retention period (#11164)
+ ~~~~
+
+ Now you're up to date.
+
+ 2. Create your working branch:
+ ~~~~
+ git checkout -b my-work
+ ~~~~
+ 3. Make your changes, add, and commit:
+ ~~~~
+ git add my-change.md
+ git commit -m "i made some changes"
+ ~~~~
+ 4. Test changes locally.
+ 5. Push your changes to your fork: ```origin```
+ ~~~~
+ git push --set-upstream origin my-work
+ ~~~~
+ 6. Go to GitHub for the Druid repo. It should realize you have a new branch in your fork. Create a pull request from your for ```my-work``` to ```master``` in the Druid repo.
+
+## Style guide
+
+Before publishing new content or updating an existing topic, audit your documentation using this checklist to make sure your contributions align with existing documentation.
+
+* Use descriptive link text. If a link downloads a file, make sure to indicate this action
+* Use present tense where possible
+* Avoid negative constructions when possible
+* Use clear and direct language
+* Use descriptive headings and titles
+* Avoid using a present participle or gerund as the first word in a heading or title
+* Use sentence case in document titles and headings
+* Don’t use images of text or code samples
+* Use SVG over PNG if available
+* Provide an equivalent text explanation with each image
+* Use the appropriate text-formatting
+* Put conditional clauses before instructions
+* Avoid gender-specific pronouns, instead use they
+* Use second person — you instead of we
+* When American spelling is different from Commonwealth/"British" spelling, use the American spelling
+* Don’t use terms considered disrespectful. Refer to the Google’s [Word list](https://developers.google.com/style/word-list) for guidance and alternatives
+* Use straight quotation marks and straight apostrophes
+* Introduce a list, a table, or a procedure with an introductory sentence
Review Comment:
In Markdown files, wrap lines at 80 characters (some like 120 in code.) No need to have one paragraph per line, except in tables.
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
Review Comment:
Most of our existing docs use backticks with the content type:
~~~text
```bash
git clone foo
```
~~~
And:
~~~text
```text
some text here
```
~~~
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
+
+## Contributing
+
+ 1. On branch ```master```, fetch the latest commit:
+
+ ~~~~
+ git fetch upstream
+
+ remote: Enumerating objects: 397, done.
+ remote: Counting objects: 100% (341/341), done.
+ remote: Compressing objects: 100% (181/181), done.
+ remote: Total 397 (delta 118), reused 255 (delta 98), pack-reused 56
+ Receiving objects: 100% (397/397), 266.19 KiB | 16.64 MiB/s, done.
+ Resolving deltas: 100% (118/118), completed with 44 local objects.
+ From https://github.com/apache/druid
+ 819d706082..6c9f926e3e 0.21.0 -> upstream/0.21.0
+ 8a3be6bccc..84aac4832d master -> upstream/master
+ * [new tag] druid-0.21.0 -> druid-0.21.0
+
+ ➜ git reset --hard upstream/master
+ HEAD is now at 84aac4832d Add feature to automatically remove rules based on retention period (#11164)
+ ~~~~
+
+ Now you're up to date.
+
+ 2. Create your working branch:
+ ~~~~
+ git checkout -b my-work
+ ~~~~
+ 3. Make your changes, add, and commit:
+ ~~~~
+ git add my-change.md
+ git commit -m "i made some changes"
+ ~~~~
+ 4. Test changes locally.
+ 5. Push your changes to your fork: ```origin```
+ ~~~~
+ git push --set-upstream origin my-work
+ ~~~~
+ 6. Go to GitHub for the Druid repo. It should realize you have a new branch in your fork. Create a pull request from your for ```my-work``` to ```master``` in the Druid repo.
+
+## Style guide
+
+Before publishing new content or updating an existing topic, audit your documentation using this checklist to make sure your contributions align with existing documentation.
+
+* Use descriptive link text. If a link downloads a file, make sure to indicate this action
+* Use present tense where possible
+* Avoid negative constructions when possible
+* Use clear and direct language
+* Use descriptive headings and titles
+* Avoid using a present participle or gerund as the first word in a heading or title
Review Comment:
Example for those of us who've forgotten this stuff from English class?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] techdocsmith commented on pull request #13868: Add docs contribution page
Posted by "techdocsmith (via GitHub)" <gi...@apache.org>.
techdocsmith commented on PR #13868:
URL: https://github.com/apache/druid/pull/13868#issuecomment-1574397355
carried by https://github.com/apache/druid/pull/14365/
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] paul-rogers commented on pull request #13868: Add docs contribution page
Posted by "paul-rogers (via GitHub)" <gi...@apache.org>.
paul-rogers commented on PR #13868:
URL: https://github.com/apache/druid/pull/13868#issuecomment-1452200385
This is great! There is already a page for the docs, though I always struggle to find it: `druid-website/README.md`. This explains some of the mechanics. Can we maybe merge these to have the info one (easy to find) place in your new page?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] 317brian commented on a diff in pull request #13868: Add docs contribution page
Posted by "317brian (via GitHub)" <gi...@apache.org>.
317brian commented on code in PR #13868:
URL: https://github.com/apache/druid/pull/13868#discussion_r1123719908
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
Review Comment:
```suggestion
If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below.
```
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
Review Comment:
```suggestion
```
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
Review Comment:
```suggestion
The Druid team works on the `master` branch and then branches for a release, such as 25.0
```
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
+
+## Contributing
+
+ 1. On branch ```master```, fetch the latest commit:
+
+ ~~~~
+ git fetch upstream
+
+ remote: Enumerating objects: 397, done.
+ remote: Counting objects: 100% (341/341), done.
+ remote: Compressing objects: 100% (181/181), done.
+ remote: Total 397 (delta 118), reused 255 (delta 98), pack-reused 56
+ Receiving objects: 100% (397/397), 266.19 KiB | 16.64 MiB/s, done.
+ Resolving deltas: 100% (118/118), completed with 44 local objects.
+ From https://github.com/apache/druid
+ 819d706082..6c9f926e3e 0.21.0 -> upstream/0.21.0
+ 8a3be6bccc..84aac4832d master -> upstream/master
+ * [new tag] druid-0.21.0 -> druid-0.21.0
+
+ ➜ git reset --hard upstream/master
+ HEAD is now at 84aac4832d Add feature to automatically remove rules based on retention period (#11164)
+ ~~~~
+
+ Now you're up to date.
+
+ 2. Create your working branch:
+ ~~~~
+ git checkout -b my-work
+ ~~~~
+ 3. Make your changes, add, and commit:
+ ~~~~
+ git add my-change.md
+ git commit -m "i made some changes"
+ ~~~~
+ 4. Test changes locally.
Review Comment:
In addition to Paul's recommendation on testing before commiting, this is probably what people should do to test.
```suggestion
4. Test changes locally by building the site and navigating to your changes. In `website`, run `docusaurus-start`. By default, this starts the site on `localhost:3000`.
```
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
+
+## Contributing
+
+ 1. On branch ```master```, fetch the latest commit:
+
+ ~~~~
+ git fetch upstream
+
+ remote: Enumerating objects: 397, done.
+ remote: Counting objects: 100% (341/341), done.
+ remote: Compressing objects: 100% (181/181), done.
+ remote: Total 397 (delta 118), reused 255 (delta 98), pack-reused 56
+ Receiving objects: 100% (397/397), 266.19 KiB | 16.64 MiB/s, done.
+ Resolving deltas: 100% (118/118), completed with 44 local objects.
+ From https://github.com/apache/druid
+ 819d706082..6c9f926e3e 0.21.0 -> upstream/0.21.0
+ 8a3be6bccc..84aac4832d master -> upstream/master
+ * [new tag] druid-0.21.0 -> druid-0.21.0
+
+ ➜ git reset --hard upstream/master
+ HEAD is now at 84aac4832d Add feature to automatically remove rules based on retention period (#11164)
+ ~~~~
+
+ Now you're up to date.
+
+ 2. Create your working branch:
+ ~~~~
+ git checkout -b my-work
+ ~~~~
+ 3. Make your changes, add, and commit:
+ ~~~~
+ git add my-change.md
+ git commit -m "i made some changes"
+ ~~~~
+ 4. Test changes locally.
+ 5. Push your changes to your fork: ```origin```
+ ~~~~
+ git push --set-upstream origin my-work
+ ~~~~
+ 6. Go to GitHub for the Druid repo. It should realize you have a new branch in your fork. Create a pull request from your for ```my-work``` to ```master``` in the Druid repo.
+
+## Style guide
+
+Before publishing new content or updating an existing topic, audit your documentation using this checklist to make sure your contributions align with existing documentation.
+
+* Use descriptive link text. If a link downloads a file, make sure to indicate this action
+* Use present tense where possible
+* Avoid negative constructions when possible
+* Use clear and direct language
+* Use descriptive headings and titles
+* Avoid using a present participle or gerund as the first word in a heading or title
Review Comment:
```suggestion
* Avoid using a present participle or gerund as the first word in a heading or title. A shortcut for this is to not start with a word that ends in `-ing`. For example, don't use "Configuring Druid." Use "Configure Druid."
```
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
+
+## Contributing
+
+ 1. On branch ```master```, fetch the latest commit:
+
+ ~~~~
+ git fetch upstream
+
+ remote: Enumerating objects: 397, done.
+ remote: Counting objects: 100% (341/341), done.
+ remote: Compressing objects: 100% (181/181), done.
+ remote: Total 397 (delta 118), reused 255 (delta 98), pack-reused 56
+ Receiving objects: 100% (397/397), 266.19 KiB | 16.64 MiB/s, done.
+ Resolving deltas: 100% (118/118), completed with 44 local objects.
+ From https://github.com/apache/druid
+ 819d706082..6c9f926e3e 0.21.0 -> upstream/0.21.0
+ 8a3be6bccc..84aac4832d master -> upstream/master
+ * [new tag] druid-0.21.0 -> druid-0.21.0
+
+ ➜ git reset --hard upstream/master
+ HEAD is now at 84aac4832d Add feature to automatically remove rules based on retention period (#11164)
+ ~~~~
+
+ Now you're up to date.
+
+ 2. Create your working branch:
+ ~~~~
+ git checkout -b my-work
+ ~~~~
+ 3. Make your changes, add, and commit:
+ ~~~~
+ git add my-change.md
+ git commit -m "i made some changes"
+ ~~~~
+ 4. Test changes locally.
+ 5. Push your changes to your fork: ```origin```
+ ~~~~
+ git push --set-upstream origin my-work
+ ~~~~
+ 6. Go to GitHub for the Druid repo. It should realize you have a new branch in your fork. Create a pull request from your for ```my-work``` to ```master``` in the Druid repo.
+
+## Style guide
+
+Before publishing new content or updating an existing topic, audit your documentation using this checklist to make sure your contributions align with existing documentation.
+
+* Use descriptive link text. If a link downloads a file, make sure to indicate this action
+* Use present tense where possible
+* Avoid negative constructions when possible
+* Use clear and direct language
+* Use descriptive headings and titles
+* Avoid using a present participle or gerund as the first word in a heading or title
+* Use sentence case in document titles and headings
+* Don’t use images of text or code samples
+* Use SVG over PNG if available
+* Provide an equivalent text explanation with each image
+* Use the appropriate text-formatting
Review Comment:
```suggestion
* Use the appropriate text-formatting. For example, make sure code snippets and property names are in code font and UI elements are bold. Additionally, you should generally avoid using bold or italics to emphasize certain words.
```
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
+
+## Contributing
+
+ 1. On branch ```master```, fetch the latest commit:
+
+ ~~~~
+ git fetch upstream
+
+ remote: Enumerating objects: 397, done.
+ remote: Counting objects: 100% (341/341), done.
+ remote: Compressing objects: 100% (181/181), done.
+ remote: Total 397 (delta 118), reused 255 (delta 98), pack-reused 56
+ Receiving objects: 100% (397/397), 266.19 KiB | 16.64 MiB/s, done.
+ Resolving deltas: 100% (118/118), completed with 44 local objects.
+ From https://github.com/apache/druid
+ 819d706082..6c9f926e3e 0.21.0 -> upstream/0.21.0
+ 8a3be6bccc..84aac4832d master -> upstream/master
+ * [new tag] druid-0.21.0 -> druid-0.21.0
+
+ ➜ git reset --hard upstream/master
+ HEAD is now at 84aac4832d Add feature to automatically remove rules based on retention period (#11164)
+ ~~~~
+
+ Now you're up to date.
+
+ 2. Create your working branch:
+ ~~~~
+ git checkout -b my-work
+ ~~~~
+ 3. Make your changes, add, and commit:
+ ~~~~
+ git add my-change.md
+ git commit -m "i made some changes"
+ ~~~~
+ 4. Test changes locally.
+ 5. Push your changes to your fork: ```origin```
+ ~~~~
+ git push --set-upstream origin my-work
+ ~~~~
+ 6. Go to GitHub for the Druid repo. It should realize you have a new branch in your fork. Create a pull request from your for ```my-work``` to ```master``` in the Druid repo.
Review Comment:
```suggestion
6. Go to the Druid repo. GitHub should recognize that you have a new branch in your fork. Create a pull request from your Druid fork and branch to the `master` branch in the Apache Druid repo.
```
##########
docs/development/contributing-to-docs.md:
##########
@@ -0,0 +1,139 @@
+---
+id: contributing-to-docs
+title: "How to contribute to Druid docs"
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you 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.
+ -->
+
+Druid is a [community-led project](https://druid.apache.org/community/) and we are delighted to receive contributions of anything from minor fixes to docs to big new features.
+
+Druid docs contributors:
+
+* Improve existing content
+* Create new content
+
+## Getting started
+
+Druid docs contributors can open an issue about documentation, or contribute a change with a pull request (PR).
+
+The open source Druid docs are located here:
+https://druid.apache.org/docs/latest/design/index.html
+
+Some of the Druid docs are incorporated into the Imply docs:
+https://docs.imply.io/latest/apache-druid-doc/
+
+If you need to update a Druid doc, locate and update the doc in the Druid repo, following the instructions below. Once a month, we run a script to update the Imply docs repo with recent updates to the Druid docs.
+
+## Druid repo branches
+
+The Druid team works on Apache Druid master, and then branches to 0.17, 0.18, etc and 017-iap (which stands for Imply Analytics Platform).
+
+See [CONTRIBUTING.md](https://github.com/apache/incubator-druid/blob/master/CONTRIBUTING.md) for instructions on contributing to Apache Druid.
+
+## Before you begin
+
+Before you can contribute to the Druid docs for the first time, you must complete the following steps:
+
+ 1. Fork the [Druid repo](https://github.com/apache/druid). Your fork will be the ```origin``` remote.
+ 2. Clone the Druid repo from your fork.
+ 3. Set up your remotes locally ```upstream``` in the Druid repo in ```.git/config```:
+ ~~~~
+ [remote "upstream"]
+ url = https://github.com/apache/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ pushurl = no_push
+ [branch "master"]
+ remote = upstream
+ merge = refs/heads/master
+ [remote "origin"]
+ url = https://github.com/{my-git-id}/druid.git
+ fetch = +refs/heads/*:refs/remotes/upstream/*
+ [branch "master"]
+ remote = origin
+ merge = refs/heads/master
+ ~~~~
+
+ For ```upstream```, ```push_url = no_push``` means you won’t accidentally push to upstream.
+ Make sure to put your github id for {my-git-id}.
+ 4. ```git config --list --show-origin``` to make sure you’ve got your email configured. If you need to set your email, you can set it per repo or globally. Global instructions [here](https://docs.github.com/en/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
+ 5. Docusaurus?
Review Comment:
Since this is in before you start, I think probably
```suggestion
5. Install Docusaurus so that you can build the site locally. Run either `npm install` or `yarn install` in the `website` directory.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org