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

Update the docs for v0.6.0 #378

Merged
merged 4 commits into from
Aug 30, 2019
Merged

Update the docs for v0.6.0 #378

merged 4 commits into from
Aug 30, 2019

Conversation

luxas
Copy link
Contributor

@luxas luxas commented Aug 30, 2019

cc @twelho

@luxas luxas requested a review from twelho as a code owner August 30, 2019 21:22
@luxas luxas added the kind/documentation Categorizes issue or PR as related to documentation. label Aug 30, 2019
@luxas luxas added this to the v0.6.0 milestone Aug 30, 2019
Copy link
Contributor

@twelho twelho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! 🎉
Some nits which would be good to fix.

README.md Outdated
@@ -64,7 +64,7 @@ Example use-cases:
- Launch and manage entire “app ready” stacks from Git because Ignite supports GitOps!
- Run even legacy or special apps in lightweight VMs (eg for multi-tenancy, or using weird/edge kernels).

And - potentially - we can run a cloud of VMs ‘anywhere’ using Kubernetes for orchestration,
And- potentially- we can run a cloud of VMs ‘anywhere’ using Kubernetes for orchestration,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dashes to italics

README.md Outdated
@@ -138,13 +138,13 @@ In Git you declaratively store the desired state of a set of VMs you want to man
`ignited gitops` reconciles the state from Git, and applies the desired changes as state is updated in the repo.
It also commits and pushes any local changes/additions to the managed VMs back to the repository.

This can then be automated, tracked for correctness, and managed at scale - [just some of the benefits of GitOps](https://www.weave.works/technologies/gitops/).
This can then be automated, tracked for correctness, and managed at scale- [just some of the benefits of GitOps](https://www.weave.works/technologies/gitops/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix dash

docs/awesome.md Outdated

## YouTube Videos

- [Weave Ignite - FireCracker Micro VM manager demo](https://youtu.be/s_O75zt-oBg) by Paavan Mistry, 10th of July, 2019
- [TGI Kubernetes 082: Weaveworks Ignite](https://youtu.be/aq-wlslJ5MQ) by Joe Beda, 12nd of July, 2019
- [Weave Ignite- FireCracker Micro VM manager demo](https://youtu.be/s_O75zt-oBg) by Paavan Mistry, 10th of July, 2019
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix dash

docs/awesome.md Outdated

## Online Events

- [WOUG: Introducing Ignite - the GitOps VM with Lucas Käldström & Radu Weiss](https://www.meetup.com/Weave-User-Group/events/262973798/) by Tamao Nakahara, 17th of July, 2019

- [WOUG: Introducing Ignite- the GitOps VM with Lucas Käldström & Radu Weiss](https://www.meetup.com/Weave-User-Group/events/262973798/) by Tamao Nakahara, 17th of July, 2019
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix dash

docs/usage.md Outdated
If nothing is displayed, hit Enter to re-display the login prompt.
Login using the credentials set in the `image` (usually `root` with password `root`).

**To detach** from the TTY, enter the key combination **^P^Q** (Ctrl + P + Q):
```

```console
root@3c5fa9a18682741f:~# <^P^Q> read escape sequence
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

INFO[0001] Detached on new line instead of read escape sequence

@twelho
Copy link
Contributor

twelho commented Aug 30, 2019

LGTM 👍

@luxas luxas mentioned this pull request Aug 30, 2019
5 tasks
@luxas luxas merged commit edd7ee6 into weaveworks:master Aug 30, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants