Pārlūkot izejas kodu

[docs] Refresh help on how to get started contributing

Romain Rigaux 4 gadi atpakaļ
vecāks
revīzija
a0032fbb1a
2 mainītis faili ar 10 papildinājumiem un 12 dzēšanām
  1. 7 9
      CONTRIBUTING.md
  2. 3 3
      docs/docs-site/content/_index.md

+ 7 - 9
CONTRIBUTING.md

@@ -1,24 +1,22 @@
 ![alt text](https://raw.githubusercontent.com/cloudera/hue/master/docs/images/hue_logo.png "Hue Logo")
 
 
-The Hue project gladly welcomes [pull requests](https://github.com/cloudera/hue/pulls)!
+The Hue project gladly welcomes [improvements](https://github.com/cloudera/hue/pulls)!
 
-This document contains instructions on how to get involved in Hue improvement.
-
-In any case, feel free to ask here in a [discussion](https://github.com/cloudera/hue/discussions).
+This document contains instructions on how to get involved. In any case, feel free to ask [questions](https://github.com/cloudera/hue/discussions).
 
 # What to improve
 
-Here is some inspiration on which areas we would love to have some contributions:
+Here is some inspiration:
 
-1. Updating a small piece of [documentation](https://docs.gethue.com)
+1. Updating a small piece of [documentation](https://docs.gethue.com). Pick a page and click on "Edit The Page".
 2. High level [Roadmap](/docs/ROADMAP.md)
-3. Check [Github issues](https://github.com/cloudera/hue/issues).
-4. Improving [SQL Components](https://docs.gethue.com/developer/components/), [SQL autocompletes](https://docs.gethue.com/developer/development/#sql-parsers) or [SQL connectors](https://docs.gethue.com/developer/sdk/) are great projects
+3. Check [Github issues](https://github.com/cloudera/hue/issues), especially [Good First Issues](https://github.com/cloudera/hue/pulls?q=is%3Apr+is%3Aopen+label%3A%22good+first+issue%22).
+4. Core areas: improving [SQL Components](https://docs.gethue.com/developer/components/) like Scratchpad and Parsers, [APIs](https://docs.gethue.com/developer/api/), Kubernetes service or [SQL connectors](https://docs.gethue.com/administrator/configuration/connectors/)
 
 # Submitting an improvement
 
-Here is an example of change: [Pull request 842](https://github.com/cloudera/hue/pull/842)
+Here is a good example of [Pull request](https://github.com/cloudera/hue/pull/2470) with code and unit test with mocks.
 
 ## Building
 

+ 3 - 3
docs/docs-site/content/_index.md

@@ -17,8 +17,8 @@ Hue is a mature SQL Assistant for querying Databases & Data Warehouses.
 use Hue to quickly answer questions via self-service querying and are executing 100s of 1000s of queries daily.
 
 Read more on [gethue.com](http://gethue.com) and
-- connect to a [Database](/administrator/configuration/connectors/)
-- build your own Editor with the [SQL Scratchpad](/developer/components/scratchpad/)
-- or Query Service by leveraging the [REST API](/developer/api/rest/) and [Kubernetes](/administrator/installation/cloud/#kubernetes)
+- Connect to a [Database](/administrator/configuration/connectors/)
+- Build your own Editor with the [SQL Scratchpad](/developer/components/scratchpad/)
+- Or Query Service by leveraging the [REST API](/developer/api/rest/) and [Kubernetes](/administrator/installation/cloud/#kubernetes)
 
 !["Hue Editor"](https://cdn.gethue.com/uploads/2021/02/hue-4.9.png)