Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Initial creation of documentation site #85

Closed
richardcase opened this issue Sep 9, 2021 · 2 comments · Fixed by #195
Closed

Initial creation of documentation site #85

richardcase opened this issue Sep 9, 2021 · 2 comments · Fixed by #195
Assignees
@yitsushi
Labels
area/build-and-release Indicates issue or PR related to build or release help wanted Requires help from contributors to get done kind/documentation Documentation only kind/feature New feature or request priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.

Comments

@richardcase
Copy link
Member

Describe the solution you'd like:
Create the infrastructure and base documentation site. The docs should have their source in the main and publish to netflify or GitHub pages

Why do you want this feature:

Anything else you would like to add:

We could follow the approach used by CAPI/CAPA
@richardcase richardcase added kind/documentation Documentation only kind/feature New feature or request help wanted Requires help from contributors to get done area/build-and-release Indicates issue or PR related to build or release labels Sep 9, 2021
@richardcase richardcase added this to the vNext milestone Sep 9, 2021
@richardcase richardcase changed the title Create documentation site Initial creation of documentation site Oct 27, 2021
@richardcase richardcase added the priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. label Oct 27, 2021
@yitsushi yitsushi self-assigned this Nov 2, 2021
@yitsushi
Copy link
Contributor

yitsushi commented Nov 2, 2021

Created a PR to enable github pages on the repo: https://github.com/weaveworks/corp/pull/2247

@yitsushi
Copy link
Contributor

yitsushi commented Nov 2, 2021

Follow-up: #194

yitsushi added a commit that referenced this issue Nov 2, 2021
@yitsushi
docs: user documentation on github pages
f3c395e 
Notice: This is more like an initial documentation site

* Documentation site is powered by Docusaurus.
* gRPC documentation is generated with `protoc-gen-doc`.
* Getting started documentation is the as the quick-start guide, but
  with separate files, so it's easye to navigate and digest the content.
  It really needs a refactoring and we have to write a real user Getting
  Started docoument.
* Enabled `blog` for now, we can turn it off if we don't want to use it.
  Created an example blog post about the v0.1.0-alpha.1 release.

Docusaurus: https://docusaurus.io/
protoc-gen-doc: https://github.com/pseudomuto/protoc-gen-doc

Fixes #85
@yitsushi yitsushi mentioned this issue Nov 2, 2021
Merged
2 tasks
yitsushi added a commit that referenced this issue Nov 3, 2021
@yitsushi
docs: user documentation on github pages
46e26e0 
Notice: This is more like an initial documentation site

* Documentation site is powered by Docusaurus.
* gRPC documentation is generated with `protoc-gen-doc`.
* Getting started documentation is the as the quick-start guide, but
  with separate files, so it's easye to navigate and digest the content.
  It really needs a refactoring and we have to write a real user Getting
  Started docoument.
* Enabled `blog` for now, we can turn it off if we don't want to use it.
  Created an example blog post about the v0.1.0-alpha.1 release.
* CNAME: docs.flintlock.dev

Docusaurus: https://docusaurus.io/
protoc-gen-doc: https://github.com/pseudomuto/protoc-gen-doc

Fixes #85
yitsushi added a commit that referenced this issue Nov 4, 2021
@yitsushi
docs: user documentation on github pages
10e2331 
Notice: This is more like an initial documentation site

* Documentation site is powered by Docusaurus.
* gRPC documentation is generated with `protoc-gen-doc`.
* Getting started documentation is the as the quick-start guide, but
  with separate files, so it's easye to navigate and digest the content.
  It really needs a refactoring and we have to write a real user Getting
  Started docoument.
* Enabled `blog` for now, we can turn it off if we don't want to use it.
  Created an example blog post about the v0.1.0-alpha.1 release.
* CNAME: docs.flintlock.dev

Docusaurus: https://docusaurus.io/
protoc-gen-doc: https://github.com/pseudomuto/protoc-gen-doc

Fixes #85
yitsushi added a commit that referenced this issue Nov 4, 2021
@yitsushi @Callisto13 @richardcase
docs: user documentation on github pages (#195)
1984d32 
* docs: user documentation on github pages

Notice: This is more like an initial documentation site

* Documentation site is powered by Docusaurus.
* gRPC documentation is generated with `protoc-gen-doc`.
* Getting started documentation is the as the quick-start guide, but
  with separate files, so it's easye to navigate and digest the content.
  It really needs a refactoring and we have to write a real user Getting
  Started docoument.
* Enabled `blog` for now, we can turn it off if we don't want to use it.
  Created an example blog post about the v0.1.0-alpha.1 release.
* CNAME: docs.flintlock.dev

Docusaurus: https://docusaurus.io/
protoc-gen-doc: https://github.com/pseudomuto/protoc-gen-doc

Fixes #85

* GitHub action to build (check) and deploy documentation

* Apply suggestions from code review
* Update proto + readme based on feedback
* Remove ADR from the footer
* Minor doc changes

Co-authored-by: Claudia <[email protected]>
Co-authored-by: Richard Case <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yitsushi yitsushi

Labels
area/build-and-release Indicates issue or PR related to build or release help wanted Requires help from contributors to get done kind/documentation Documentation only kind/feature New feature or request priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: user documentation on github pages liquidmetal-dev/flintlock
2 participants
@yitsushi @richardcase