瀏覽代碼

HUE-9414 [docs] Clean-up the release checklist

Add a temporary image for the ERD
Romain 5 年之前
父節點
當前提交
71befaf166

+ 9 - 3
docs/docs-site/content/developer/components/er-diagram/_index.md

@@ -3,7 +3,11 @@ title: "er-diagram"
 draft: false
 ---
 
-Hue ERD provides an illustration of various entities, and the relationship between them. Entity types supported by ERD currently are `Table` & `Literal`. We have a very generic architecture, and more types of entities can be supported in the future.
+The [Entity-relationship model](https://en.wikipedia.org/wiki/Entity%E2%80%93relationship_model) (ERD) provides an illustration of various SQL entities, and the relationship between them. Entity types supported by the ERD diagram are currently `Table` & `Literal`. It has a very generic architecture, and more types of entities can be supported in the future.
+
+!["EDR Table Component"](https://cdn.gethue.com/uploads/2020/07/erd_table_viz.png)
+
+## Import
 
 Please refer [here](/developer/components/#using-ui-components-in-your-project) for importing the component in your own project. Also [er-diagram-demo](https://github.com/cloudera/hue/tree/master/tools/examples/components/er-diagram-demo) app have working examples.
 
@@ -11,7 +15,9 @@ Once imported `er-diagram` can be used like a native HTML tag.
 
     <er-diagram id="erd-element-id"/>
 
-### Attributes / Props
+## Properties
+
+### Attributes
 
 - entities: Array &lt;[IEntity](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/js/components/er-diagram/lib/interfaces.ts#L21)&gt; - An array of entity objects. Each entity will be a box in the UI.
 - relations: Array &lt;[IRelation](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/js/components/er-diagram/lib/interfaces.ts#L26)&gt; - An array of relation objects. Each relation will connect two of the above entities.
@@ -22,7 +28,7 @@ Please refer the [interfaces](https://github.com/cloudera/hue/blob/master/deskto
 
 - entity-clicked: Function([IEntity](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/js/components/er-diagram/lib/interfaces.ts#L21)) - Will be triggered when an entity is clicked.
 
-## Resource Files
+### Resource Files
 
 - Hue
   - **Web Component:** gethue/web/er-diagram.js

+ 17 - 12
docs/docs-site/content/developer/development/_index.md

@@ -721,6 +721,10 @@ Historically, the same thing used to be done with the `requires_hadoop` tag:
 
 ## Releasing
 
+The checklist below details the steps. Then send the release notes to the [Forum](https://discourse.gethue.com/), [hue-user](https://groups.google.com/a/cloudera.org/forum/#!forum/hue-user), https://twitter.com/gethue !
+
+### Version
+
 Update the versions to the next release (current release +1):
 
     :100644 100644 4db6d5f... f907d04... M	VERSION
@@ -758,6 +762,8 @@ Push to the CDN:
 
     scp hue-4.7.0.tgz root@cdn.gethue.com:/var/www/cdn.gethue.com/downloads
 
+### Websites
+
 Other things to update:
 
 * In Jira, setting the [release as shipped](https://issues.cloudera.org/projects/HUE?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page&status=all) and moving all non finished jiras to another target. Also archiving old releases.
@@ -779,17 +785,13 @@ Instructions:
     docker push gethue/nginx
     docker push gethue/nginx:4.7.0
 
-Documentation
-
-[Build it](#Documentation) and push it to the docs host.
-
-Build the doc website:
+### Documentation
 
-    cd docs/docs-site
+Documentation is currently being auto refreshed every morning of the week and run as a container.
 
-    hugo
+The manual process otherwise would be to [build it](#Documentation) and push it to the docs host.
 
-Release:
+### Release
 
     ssh root@docs.gethue.com
     cd /var/www/docs.gethue.com
@@ -800,10 +802,7 @@ Release:
 
     scp -r hue-4.6/build/release/prod/hue-4.7.0.tgz root@cdn.gethue.com:/var/www/cdn.gethue.com/downloads/
 
-
-Then send release notes to the [Forum](https://discourse.gethue.com/), [hue-user](https://groups.google.com/a/cloudera.org/forum/#!forum/hue-user), https://twitter.com/gethue !
-
-### Publishing GetHue
+### NPM registry
 
 To publish gethue to NPM registry, the following command would have to be run. Kindly refrain from using `npm publish`.
 
@@ -852,6 +851,12 @@ Check for links not working (e.g. returning a 404) with muffet, a fast link chec
 
 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.
 
+And then to build the static site just do:
+
+    hugo
+
+and grab the `public` directory.
+
 ### 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).