incubator-heron icon indicating copy to clipboard operation
incubator-heron copied to clipboard

Updating Apache Site Todo's

Open joshfischer1108 opened this issue 6 years ago • 0 comments

To keep work from being duplicated check off a section you would like to do and create one pull request per task please.

Below are a list of things that need to be done to get the new site under the folder website2 to be compliant and working correctly. Once we get these tasks taken care of we should be good to create the new heron site. Feel free to add comments on anything I may have missed.

  • fix all of the broken links in the markdown files The following list is a list of the menu topics. I've checked off the ones that have been checked for correctly routed links. These check marks do not count towards the Java or Pydoc links. These still need to be generated from Bazel.
  • [x] Getting Started
  • [x] Deployment
  • [x] Topology Development APIs
  • [x] Guides
  • [x] Heron Concepts
  • [x] State Managers
  • [x] Uploaders
  • [x] Schedulers // Josh will take this whole scheduler section
    • [x] K8's by hand
    • [x] K8's with Helm
    • [x] Aurora cluster
    • [x] Local Aurora Cluster
    • [x] multi node standalone cluster
    • [x] Nomad
    • [x] Local Cluster
    • [x] Mesos Cluster Locally
    • [x] Slurm Cluster
    • [x] Yarn Cluster
  • [x] Cluster Configuration
  • [x] Observability
  • [x] User Manuals
  • [x] Compiling
  • [x] Extending Heron
  • [x] Heron Resources

-------- Other Things

  • [ ] replace the old gohugo references to the heron version
  • [ ] replace the old gohugo references to {{% githubMaster %}}
  • [x] Check for any missing images
  • [ ] Check for any incorrect docs that I may have created.
  • [x] Add a way to create the create the kubernetes by hand yaml config section.. It is currently not created. For reference look here https://apache.github.io/incubator-heron/docs/operators/deployment/schedulers/kubernetes/#heron-on-kubernetes-configuration

And finally

  • [ ] Create our first set of versioned docs for the already released version 0.20.0 after all above issues are resolved.

I have some instructions in the README on the how the docs should be organized, how to build and etc. I followed the conventions that the Pulsar project implemented. It seems to work out well for them. There are still some docs I think we could add to the community page.

The read can be found in {projectRoot}/website2/

Please review.

joshfischer1108 avatar Jun 19 '19 02:06 joshfischer1108