Environment | URL | Build Status |
---|---|---|
Production | https://dcos.io | |
Development | https://dev.dcos.io |
-
Add repo fork as remote repo:
git remote add fork https://github.com/<github-user>/dcos-website git fetch fork
-
Checkout the develop branch:
git checkout develop
-
Update the dcos-docs submodule:
git submodule update --init --recursive
-
Install dependencies:
npm install
-
Launch local dev server:
npm start
(opens dev server in browser)
-
Create a new feature branch:
git checkout -b feature/<feature-name>
-
Make local changes
-
Verify changes in dev server (updates automatically when files are changed)
-
Add and Commit changes
git add -p . git commit
-
Rebase repo fork to include recent dcos/dcos-website:develop changes
Rebasing a repo (instead of merging) will keep your fork commit history clean and move all your changes to the top of the commit log.
git pull --rebase origin develop
(may require resolving conflicts)
-
Push changes to repo fork feature branch
git push -u fork feature/<feature-name>
-
Create a pull request from the repo fork feature branch to dcos/dcos-website:develop
Once changes are accepted and merged to the develop branch, CI will push the updates to https://dev.dcos.io/.
Docs should be updated on develop
by maintainers to avoid git sha merge conflicts:
git checkout origin develop
scripts/bump_docs.sh
git push
Once changes have been previewed and accepted on https://dev.dcos.io/, the maintainers will rebase develop
to master
:
git fetch origin
git checkout master
git pull --rebase origin develop
git push
aws configure --profile dcos
scripts/setup-redirects.sh
Add to redirects
with the following format:
/from/ /to/
Built using Metalsmith.
Copyright 2016 Mesosphere, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this repository except in compliance with the License.
The contents of this repository are solely licensed under the terms described in the LICENSE file included in this repository.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Authors are listed in AUTHORS.md file.