Эх сурвалжийг харах

HUE-8888 [docs] Add README to the source of the docs

Romain 5 жил өмнө
parent
commit
12c5057c9e

+ 7 - 0
docs/README.md

@@ -0,0 +1,7 @@
+# Documentations
+
+docs.gethue.com: [source](/docs/docs-site), [documentation](https://docs.gethue.com/developer/development/#blog--website)
+
+gethue.com: [source](/docs/gethue), [documentation](https://docs.gethue.com/developer/development/#documentation)
+
+Designs: [source](/docs/designs/)

+ 6 - 8
docs/docs-site/content/developer/development/_index.md

@@ -780,26 +780,24 @@ and recompiling the Docker image. It will then auto-restart on Python code chang
 
 
 ### Documentation
 ### Documentation
 
 
-Install [Hugo](https://gohugo.io/getting-started/quick-start/).
+Install [Hugo](https://gohugo.io/getting-started/quick-start/). Each page has a link to its own source file in the top right corner.
 
 
-Build it and see live changes:
+Build the [source](https://github.com/cloudera/hue/tree/master/docs/docs-site) and see live changes:
 
 
     cd docs/docs-site
     cd docs/docs-site
 
 
     hugo serve
     hugo serve
 
 
-Check for links not working (returning a 404) with muffet, a fast link checker crawler:
-
-    sudo snap install muffet
+Check for links not working (e.g. returning a 404) with muffet, a fast link checker crawler. It recommended to use the [check links script](https://github.com/cloudera/hue/blob/master/tools/ci/check_for_website_dead_links.sh).
 
 
-Then after booting the hugo documentation server, we point to its url. We also blacklist certain urls to avoid some noisy false positives:
-
-    muffet http://localhost:35741/ --exclude ".*releases.*" -f
+The posts [manual](https://gethue.com/easily-checking-for-deadlinks-on-docs-gethue-com/) and [continuous integration](https://gethue.com/easily-checking-for-deadlinks-on-docs-gethue-com/) contain more information about it.
 
 
 ### Blog & Website
 ### Blog & Website
 
 
 Like for the [Documentation](#Documentation) install hugo. The content for each language is in its [own directory](https://github.com/cloudera/hue/tree/master/docs/gethue/content).
 Like for the [Documentation](#Documentation) install hugo. The content for each language is in its [own directory](https://github.com/cloudera/hue/tree/master/docs/gethue/content).
 
 
+Blog posts are located in [docs/gethue/content/en/posts](https://github.com/cloudera/hue/tree/master/docs/gethue/content/en/posts).
+
 Build it and see live changes:
 Build it and see live changes:
 
 
     cd docs/gethue
     cd docs/gethue