Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.

Joshfischer/newsite #3280

Merged
merged 34 commits into from Jun 14, 2019
Merged

Conversation

joshfischer1108
Copy link
Member

@joshfischer1108 joshfischer1108 commented Jun 2, 2019

@nwangtw this is a start to the new site that allows for us to version our docs on releases as well as keep a constant build for our content that typically doesn't change much. There are still a few things to do.

  • 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.
  • Getting Started
  • Deployment
  • Topology Development APIs
  • Guides
  • Heron Concepts
  • State Managers
  • Uploaders
  • Schedulers
  • Cluster Configuration
  • Observability
  • User Manuals
  • Compiling
  • Extending Heron
  • Heron Resources
  • replace the old gohugo references to the heron version
    - Check for any missing images
  • Check for any incorrect docs that I may have created.
  • I'm sure I missed something along the way

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.

Please review.

CC @dave2wave

@nwangtw nwangtw merged commit 4b193e0 into apache:master Jun 14, 2019
sreev pushed a commit to sreev/incubator-heron that referenced this pull request Apr 9, 2020
* adding new start to site

* adding getting started and deployment docs.. Still need to add image assets.  Adding community drop down

* adding getting started and deployment docs.. Still need to add image assets.  Adding community drop down

* spelling

* adding assets and api docs

* adding sections to new site

* removed duplicated file.  Adding serialization page in

* renaming subsections

* rename topology docs

* rename guide section docs

* rename guide section docs

* folder name change

* adding uploaders

* clean up site layout

* adding kubernetes by hand. still need to find a way to generate tables

* adding kubernetes with helm docs

* adding aurora files

* adding rest of scheduler docs

* adding config sections

* adding cluster config section

* adding observability and user manual sections

* adding a compiling and extending heron section

* removing template files.  Updating new website readme to set standards

* adding start to versioning

* revert

* adding heron resources

* adding resources

* correcting links on local single node page

* getting started link checked

* deployment docs link checked

* fixing links for topology development docs

* topology development api section complete

* guides section complete

* heron concepts section link checked
nicknezis pushed a commit that referenced this pull request Sep 14, 2020
* adding new start to site

* adding getting started and deployment docs.. Still need to add image assets.  Adding community drop down

* adding getting started and deployment docs.. Still need to add image assets.  Adding community drop down

* spelling

* adding assets and api docs

* adding sections to new site

* removed duplicated file.  Adding serialization page in

* renaming subsections

* rename topology docs

* rename guide section docs

* rename guide section docs

* folder name change

* adding uploaders

* clean up site layout

* adding kubernetes by hand. still need to find a way to generate tables

* adding kubernetes with helm docs

* adding aurora files

* adding rest of scheduler docs

* adding config sections

* adding cluster config section

* adding observability and user manual sections

* adding a compiling and extending heron section

* removing template files.  Updating new website readme to set standards

* adding start to versioning

* revert

* adding heron resources

* adding resources

* correcting links on local single node page

* getting started link checked

* deployment docs link checked

* fixing links for topology development docs

* topology development api section complete

* guides section complete

* heron concepts section link checked
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants