Skip to content
This repository was archived by the owner on Jun 20, 2024. It is now read-only.

Compare: WorkingOnWeave

Showing with 0 additions and 22 deletions.
  1. +0 −22 WorkingOnWeave.md
22 changes: 0 additions & 22 deletions WorkingOnWeave.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,25 +77,3 @@ For each mainline release with tag `vX.Y.0` there will be a release branch forke

* When you merge a PR into a release branch, you are responsible for manually merging from the release branch into `master`
* GitHub does not automatically close issues that are only mentioned as fixed/closed in the PR comments when the target branch isn't master - even when you manually merge it to master afterwards. The recommended procedure is to duplicate the fixes/closed notation _in your comment on the initial merge to the release branch_ - GitHub will do the right thing when this merge commit is subsequently merged into master.

## Working on docs

[Wordepress](https://github.com/weaveworks/wordepress) is used to publish docs to our dev and live Wordpress instances via the CI system. Content (in markdown) lives in the repository under `site/` and adheres to the [Wordepress format](https://github.com/weaveworks/wordepress#repo-format).

Docs are built automatically by Circle CI and published to different locations depending on the nature of the branch:

* Pushes/merges to `master` are published at https://dev-weavewww.pantheonsite.io/docs/net/master/introducing-weave/
* Pushes/merges to release branches e.g. `1.5` are published to the live website under the most recent release tag on that branch, e.g. https://www.weave.works/docs/net/1.5.0/introducing-weave/ and to the floating 'latest' URL https://www.weave.works/docs/net/latest/introducing-weave/
* Pushes/merges to other branches e.g. `issues/NNNN-short-description` are published at e.g. https://dev-weavewww.pantheonsite.io/docs/net/issues/NNNN-short-description/introducing-weave/

### Looking at doc changes locally

If you wish to preview doc changes before pushing them to the main repo, you will need to install a local WordPress instance and [configure it for Wordepress](https://github.com/weaveworks/wordepress#configure-wordpress); Weaveworks employees may use the private [wordpress.local](https://github.com/weaveworks/wordpress.local) repository to get a faithful local clone of the production website.

### Release process

See [here](Release-Process)

### Updating docs for the latest release

Any doc changes which are merged to the latest release branch are automatically published to the live site. You will be able to preview the results prior to merge as described above.