-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Resolve merge conflicts between release-0.6.1 and release
- Loading branch information
Showing
314 changed files
with
8,113 additions
and
6,080 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 11 additions & 11 deletions
22
.for_maintainers/release/GITBOOK_RELEASE.md → ...ntainers/release/DOCUMENTATION_RELEASE.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,50 @@ | ||
# Building and pushing Wallaroo Documentation Gitbook | ||
# Building and pushing Wallaroo Documentation | ||
|
||
This document is aimed at members of the Wallaroo team who might be building and pushing the Wallaroo Documentation Gitbook for a release candidate, release, or master branch. It serves as a checklist that can take your through the gitbook release process step-by-step. | ||
This document is aimed at members of the Wallaroo team who might be building and pushing the Wallaroo Documentation for a release candidate, release, or master branch. It serves as a checklist that can take your through the documentation release process step-by-step. | ||
|
||
To learn more about our release process, see [RELEASE.md](RELEASE.md). | ||
|
||
## Prerequisites for building and pushing Wallaroo Documentation Gitbook | ||
## Prerequisites for building and pushing Wallaroo Documentation | ||
|
||
In order to build and push the Wallaroo Documentation Gitbook, you absolutely must have: | ||
In order to build and push the Wallaroo Documentation, you absolutely must have: | ||
|
||
* Provisioned the Wallaroo Release Vagrant box as described in [PROVISION_VAGRANT.md](PROVISION_VAGRANT.md) and ssh'ed into it. | ||
|
||
## Building and pushing Wallaroo Documentation Gitbook | ||
## Building and pushing Wallaroo Documentation | ||
|
||
Please note that this document was written with the assumption that you are using a clone of the `wallaroolabs/wallaroo` repo. This process will not work without modification if you try to use a fork rather than a clone of the repo. The `github-release.sh` script assumes you are using the `release` branch, `master` branch, or a release candidate branch that follows the `release-*` format. | ||
|
||
### Pull latest changes for your branch | ||
|
||
From within the Wallaroo Vagrant box, you'll want to run a `git pull` for the branch you plan to use to build and release the Wallaroo Documentation Gitbook like so: | ||
From within the Wallaroo Vagrant box, you'll want to run a `git pull` for the branch you plan to use to build and release the Wallaroo Documentation like so: | ||
|
||
```bash | ||
cd ~/wallaroo | ||
git checkout origin/RELEASE_BRANCH | ||
git pull | ||
``` | ||
|
||
So if you were going to release the Wallaroo Documentation Gitbook using `release-0.4.0`, you'd run the following: | ||
So if you were going to release the Wallaroo Documentation using `release-0.4.0`, you'd run the following: | ||
|
||
```bash | ||
cd ~/wallaroo | ||
git checkout origin/release-0.4.0 | ||
git pull | ||
``` | ||
|
||
### Building and pushing the Wallaroo Documentation Gitbook | ||
### Building and pushing the Wallaroo Documentation | ||
|
||
From within the Wallaroo Vagrant box run the following: | ||
|
||
```bash | ||
cd /users/ubuntu/wallaroo | ||
bash .release/gitbook-release.sh VERSION COMMIT | ||
bash .release/documentation-release.sh VERSION COMMIT | ||
``` | ||
|
||
So, for example, if your version is release-0.4.0 and your commit is `0xa0ece`, you'd run: | ||
|
||
```bash | ||
bash .release/gitbook-release.sh release-0.4.0 0xa0ece | ||
bash .release/documentation-release.sh release-0.4.0 0xa0ece | ||
``` | ||
|
||
This will then build and push the Wallaroo Documentation Gitbook to the `wallaroolabs/docs.wallaroolabs.com` Github repository. | ||
This will then build and push the Wallaroo Documentation to the `wallaroolabs/docs.wallaroolabs.com` Github repository. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[submodule "documentation/themes/ananke"] | ||
path = documentation/themes/ananke | ||
url = https://github.com/budparr/gohugo-theme-ananke.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.