Skip to content
This repository has been archived by the owner on Nov 9, 2020. It is now read-only.

Commit

Permalink
[SKIP CI] Steps to promote document changes from vmware master to gh-…
Browse files Browse the repository at this point in the history
…pages branch
  • Loading branch information
shuklanirdesh82 committed Jul 18, 2017
1 parent a7641eb commit e75d088
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 17 deletions.
18 changes: 1 addition & 17 deletions CI.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,23 +38,7 @@ When there is a failure unrelated to your PR, you may want to *Restart* the fail

Here are some known issues with current CI/CD system, if you run into any of the following **please** hit *Restart* button to re-run tests against your PR.

- [Issue#1436](https://github.com/vmware/docker-volume-vsphere/issues/1436): Deploy esx failed with error: Failed to create ramdisk vibtransaction

```
=> Deploying to ESX root@192.168.31.62 Sat Jun 17 04:26:23 UTC 2017
Errors:
[InstallationError]
Failed to create ramdisk vibtransaction
Please refer to the log file for more details.
=> deployESXInstall: Installation hit an error on root@192.168.31.62 Sat Jun 17 04:26:32 UTC 2017
make[1]: *** [deploy-esx] Error 2
make: *** [deploy-esx] Error 2
=> Build + Test not successful Sat Jun 17 04:26:32 UTC 2017
```
- There is not any known issue of the CI/CD system. Incase of CI failure which is unrelated to your PR, please raise a new issue.

### Running CI/CD on a dev setup
Each developer can run tests part of the CI/CD system locally in their sandbox. This section describes how to configure your development setup for running CI/CD. If you are looking for configuring local testbed setup, **please refer** [Setting up local testbed](#local-testbed-setup).
Expand Down
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,19 @@ Read the [FAQ on the Wiki](https://github.com/vmware/docker-volume-vsphere/wiki#
* We don't have formal coding conventions at this point.
* Add `[WIP]` or `[PREVIEW]` to the PR title to let reviewers know that the PR is not ready to be merged.

#### Documentation PR
Any changes to `[master]/docs` will not be promoted to `gh-pages` (document release branch). The process is not automated yet and you need to copy them manually. Please use following steps and generate the separate PR to merge changes to `gh-pages`.

```
1. Checkout the local gh-pages branch
e.g. git checkout -b localdocs vmware/gh-pages
2. Copy markdown file changes to `gh-pages/jekyll-docs` respective markdown file.
e.g. any changes to `[master]/docs/user-guide/admin-cli.md` should be copied to `gh-pages/jekyll-docs/admin-cli.md`
3. When ready post a PR
```

**Note**: Make sure your code follows same style and convention as existing code.

See [Typical Developer Workflow](#typical-developer-workflow) to get started.
Expand Down

0 comments on commit e75d088

Please sign in to comment.