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

Fix too-long lines #260

Merged
merged 1 commit into from
Mar 12, 2018
Merged

Fix too-long lines #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 37 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,37 @@

# Deconst documentation

Documentation for the *deconst* project: a continuous delivery pipeline for heterogenous documentation. It's also used to develop deconst itself, like some kind of documentation ouroboros. You can read the documentation itself at [deconst.horse](https://deconst.horse/).
Documentation for the *deconst* project: a continuous delivery
pipeline for heterogenous documentation. It's also used to develop
deconst itself, like some kind of documentation ouroboros. You can
read the documentation itself at
[deconst.horse](https://deconst.horse/).

## Building

To build this documentation standalone, use the [Deconst client](https://github.com/deconst/client). Use the Sphinx preparer and a clone of `https://github.com/deconst/deconst-docs-control` as the control repository.
To build this documentation standalone, use the [Deconst
Copy link
Member

Choose a reason for hiding this comment

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

We should actually remove info around the Client since it's broken. Want to do that here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Preference is to leave this PR just about line length.

AFA the Client, do we ever plan to fix it? Here's an issue to track the discussion: #261

client](https://github.com/deconst/client). Use the Sphinx preparer and a clone
of `https://github.com/deconst/deconst-docs-control` as the control repository.

### DNS and TLS

DNS entries for `deconst.horse`, `build.deconst.horse`, `staging.deconst.horse`, and `content.staging.deconst.horse` are managed by Cloud DNS entries in the "drgsites" account. They should be pointed to the appropriate load balancers.
DNS entries for `deconst.horse`, `build.deconst.horse`, `staging.deconst.horse`,
and `content.staging.deconst.horse` are managed by Cloud DNS entries in the
"drgsites" account. They should be pointed to the appropriate load balancers.
Copy link
Member

Choose a reason for hiding this comment

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

Probably should take a look at pulling some of this out since it lives in the ops playbooks. Do you want me to do that, or would you prefer to look through on a first pass?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Preference is to leave this PR just about line length.

Issue to track: #262


TLS certificates are currently retrieved from Let's Encrypt by a manual, downtime-inducing process. To reissue them:
TLS certificates are currently retrieved from Let's Encrypt by a manual,
downtime-inducing process. To reissue them:

* Run `script/reissue` in your
[deconst/deploy](https://github.com/deconst/deploy) clone to reissue and
download the new certificates to `le_certificates/`.

* Copy and paste the new certificate as the `ssl_key:` entry in
`credentials.yml`.

* Use `script/encrypt` to encrypt the modified credentials file and commit and
push it to nexus-credentials.

* Run `script/reissue` in your [deconst/deploy](https://github.com/deconst/deploy) clone to reissue and download the new certificates to `le_certificates/`.
* Copy and paste the new certificate as the `ssl_key:` entry in `credentials.yml`.
* Use `script/encrypt` to encrypt the modified credentials file and commit and push it to nexus-credentials.
* Invoke Ansible to roll it out:

```bash
Expand All @@ -29,7 +45,8 @@ $ script/deploy \

# Deconst Dev Env in Kubernetes with Minikube

These instructions will prepare and submit the content and assets for this deconst documentation in a dev env in Kubernetes with Minikube.
These instructions will prepare and submit the content and assets for this
deconst documentation in a dev env in Kubernetes with Minikube.

1. If necessary, deploy the [presenter service](https://github.com/deconst/presenter#deconst-dev-env-in-kubernetes-with-minikube)

Expand All @@ -49,7 +66,9 @@ These instructions will prepare and submit the content and assets for this decon

1. Submit the content

The `CONTENT_SERVICE_APIKEY` must match the `ADMIN_APIKEY` set when deploying the [content service](https://github.com/deconst/content-service#deconst-dev-env-in-kubernetes-with-minikube).
The `CONTENT_SERVICE_APIKEY` must match the `ADMIN_APIKEY` set when
deploying the [content
service](https://github.com/deconst/content-service#deconst-dev-env-in-kubernetes-with-minikube).

```bash
export CONTENT_SERVICE_URL=$(minikube service --url --namespace deconst content)
Expand All @@ -63,7 +82,10 @@ These instructions will prepare and submit the content and assets for this decon

1. Prepare the staging content

The [staging environment](https://deconst.horse/developing/staging/) is a specially configured content service and presenter pair that allow users to preview content. Normally the Strider server will push preview content to the staging environment but this is how you would manually do it.
The [staging environment](https://deconst.horse/developing/staging/) is a
specially configured content service and presenter pair that allow users to
preview content. Normally the Strider server will push preview content to
the staging environment but this is how you would manually do it.

```bash
export CONTENT_ID_BASE=https://github.com/staging/deconst/deconst-docs/
Expand Down Expand Up @@ -100,7 +122,9 @@ These instructions will prepare and submit the content and assets for this decon

1. Recreate the content DB

The content is stored in the mongo DB files at `/data/deconst/mongo` in the minikube VM. Delete the DB files and the mongo pod. Kubernetes will automatically restart the mongo pod.
The content is stored in the mongo DB files at `/data/deconst/mongo` in the
minikube VM. Delete the DB files and the mongo pod. Kubernetes will
automatically restart the mongo pod.

```bash
minikube ssh
Expand All @@ -110,4 +134,5 @@ These instructions will prepare and submit the content and assets for this decon
kubectl delete po/$MONGO_POD_NAME --namespace deconst
```

Now you can run through the instructions above again to prepare and submit the content.
Now you can run through the instructions above again to prepare and submit
the content.
Loading