Skip to content
This repository has been archived by the owner on Nov 15, 2022. It is now read-only.

Gaps in documentation (add getting started guide, update user guide and examples) #501

Closed
3 tasks done
cdrage opened this issue Nov 28, 2017 · 4 comments
Closed
3 tasks done

Comments

@cdrage
Copy link
Collaborator

cdrage commented Nov 28, 2017

Some gaps within the documentation at the moment.

  • Need a Getting Started guide in order to facilitate different development scenarios (against bare-metal, minikube, minishift, etc.)
  • Update the User Guide with more information / elaborate on all commands
  • Highlight examples / make examples more prominent within Kedge.
@cdrage
Copy link
Collaborator Author

cdrage commented Dec 4, 2017

PR for getting started guide added here #508

@cdrage
Copy link
Collaborator Author

cdrage commented Dec 4, 2017

@kadel Creating something similar to https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands for examples + kedge CLI reference.

We will essentially have two slate sections (similar to how they do it within http://kubernetes.io).

My thinking is that by creating a separate one for kedge CLI (converting http://kedgeproject.org/user-guide/ to slate) we can also elaborate / focus on examples.

Thus in the side-bar we would have:

Introduction (normal site)
Quick Start (normal site)
User Guide / CLI reference (slate site)
File Reference (slate site)
Development (normal site)

WDYT?

@pradeepto
Copy link
Member

LGTM

@cdrage
Copy link
Collaborator Author

cdrage commented Dec 14, 2017

Going to close this 👍 Since I've completely each-task.

@cdrage cdrage closed this as completed Dec 14, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants