You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by fr...@apache.org on 2022/09/16 02:31:17 UTC

[druid] branch master updated: Docs – README.md update around documentation contributions (#12850)

This is an automated email from the ASF dual-hosted git repository.

frankchen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/druid.git


The following commit(s) were added to refs/heads/master by this push:
     new 68262e43f8 Docs – README.md update around documentation contributions (#12850)
68262e43f8 is described below

commit 68262e43f88876ac7041d5df509760f6185fcf3f
Author: Peter Marshall <pe...@uriam.com>
AuthorDate: Fri Sep 16 03:31:06 2022 +0100

    Docs – README.md update around documentation contributions (#12850)
    
    * Update README.md
    
    Expansion on the process and where everything is.
    
    * Update README.md
    
    Switcheroo and a typo fix.
    
    * Update README.md
    
    Header link update to take to the H2.
    
    * Update README.md
    
    Reverted docs link after feedback
    
    * Update README.md
    
    Amended language.
    
    Co-authored-by: Charles Smith <te...@gmail.com>
    
    * Update README.md
    
    PR term update
    
    Co-authored-by: Charles Smith <te...@gmail.com>
---
 README.md | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 09d834c2dc..aea332f194 100644
--- a/README.md
+++ b/README.md
@@ -72,11 +72,9 @@ Use the built-in query workbench to prototype [DruidSQL](https://druid.apache.or
 
 ### Documentation
 
-You can find the [documentation for the latest Druid release](https://druid.apache.org/docs/latest/) on
-the [project website](https://druid.apache.org).
+See the [latest documentation](https://druid.apache.org/docs/latest/) for the documentation for the current official release.  If you need information on a previous release, you can browse [previous releases documentation](https://druid.apache.org/docs/).
 
-If you would like to contribute documentation, please do so under
-`/docs` in this repository and submit a pull request.
+Make documentation and tutorials updates in [`/docs`](https://github.com/apache/druid/tree/master/docs) using [MarkDown](https://www.markdownguide.org/) and contribute them using a pull request.
 
 ### Community
 


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org