forked from etcd-io/website
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: lucperkins <[email protected]>
- Loading branch information
1 parent
2064917
commit f1dbe60
Showing
3 changed files
with
60 additions
and
8 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
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,3 +1,48 @@ | ||
# etcd.io | ||
|
||
This repository houses all of the assets used to build the future website and documentation at https://etcd.io. | ||
This repository houses all of the assets used to build the future website and documentation at https://etcd.netlify.com. The site will eventually be available at https://etcd.io. | ||
|
||
## Run the site locally | ||
|
||
### Prerequisites | ||
|
||
In order to run the site locally, you need to have the following installed: | ||
|
||
* The [Yarn](https://yarnpkg.com/en/) package manager | ||
* The [Hugo](https://gohugo.io) static site generator. Check the [`netlify.toml`](./netlify.toml) configuration file to see which version of Hugo you need to install. | ||
|
||
> **Note**: You need to install the "extended" version of Hugo with support for [Sass](https://sass-lang.com/). | ||
### Setup | ||
|
||
Once you've installed the [prerequisites](#prerequisites): | ||
|
||
```bash | ||
make setup | ||
``` | ||
|
||
### Running | ||
|
||
Once the [setup](#setup) has completed, you can run the site in your local environment: | ||
|
||
```bash | ||
make serve | ||
``` | ||
|
||
#### Docker | ||
|
||
You can also run the site locally using [Docker](https://docker.com): | ||
|
||
```bash | ||
make docker-serve | ||
``` | ||
|
||
## Publishing the site | ||
|
||
The site is published automatically by [Netlify](https://netlify.com). Any time | ||
changes are pushed to the `master` branch, the site is rebuilt and redeployed. | ||
|
||
### Preview builds | ||
|
||
Any time you submit a pull request to this repository, Netlify will publish a [preview build](https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/) of the changes in that pull request. You can find a link to the preview build in the checks section of the pull request, under ** | ||
netlify/etcd/deploy-preview**. |
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