Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

Commit

Permalink
Hard coded release version for sphinx-copybutton and updated code blo…
Browse files Browse the repository at this point in the history
…cks to use console and ShellSession where required.

Signed-off-by: Kevin Putnam <[email protected]>
  • Loading branch information
intelkevinputnam committed Jun 4, 2020
1 parent 313419b commit 48f4ea4
Show file tree
Hide file tree
Showing 8 changed files with 169 additions and 160 deletions.
12 changes: 6 additions & 6 deletions docs/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,23 +341,23 @@ pkg/pmem-registry/pmem-registry.pb.go is generated from pkg/pmem-registry/pmem-r

protoc comes from package _protobuf-compiler_ on Ubuntu 18.04
- get protobuf for Go:
```sh
``` console
$ git clone https://github.com/golang/protobuf.git && cd protobuf
$ make # installs needed binary in $GOPATH/bin/protoc-gen-go
```

- generate by running in \~/go/src/github.com/intel/pmem-csi/pkg/pmem-registry:

```sh
protoc --plugin=protoc-gen-go=$GOPATH/bin/protoc-gen-go --go_out=plugins=grpc:./ pmem-registry.proto
``` console
$ protoc --plugin=protoc-gen-go=$GOPATH/bin/protoc-gen-go --go_out=plugins=grpc:./ pmem-registry.proto
```

### Table of Contents in README and DEVELOPMENT

Table of Contents can be generated using multiple methods.
- One possibility is to use [pandoc](https://pandoc.org/)

```sh
``` console
$ pandoc -s -t markdown_github --toc README.md -o /tmp/temp.md
```

Expand All @@ -379,8 +379,8 @@ theme.

Building the documentation requires Python 3.x and venv.

```bash
make vhtml
``` console
$ make vhtml
```

### Edit
Expand Down
6 changes: 3 additions & 3 deletions docs/autotest.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ the default `pmem-govm` cluster name via the `CLUSTER` env variable.
For example, this invocation sets up a cluster using the non-default
Fedora distro:

``` sh
```
TEST_DISTRO=fedora CLUSTER=fedora-govm make start
```

Expand All @@ -128,7 +128,7 @@ can be used to run individual tests and to control additional aspects
of the test run. For example, to run just the E2E provisioning test
(create PVC, write data in one pod, read it in another) in verbose mode:

``` sh
``` console
$ KUBECONFIG=$(pwd)/_work/pmem-govm/kube.config REPO_ROOT=$(pwd) ginkgo -v -focus=pmem-csi.*should.provision.storage.with.defaults ./test/e2e/
Nov 26 11:21:28.805: INFO: The --provider flag is not set. Treating as a conformance test. Some tests may not be run.
Running Suite: PMEM E2E suite
Expand All @@ -150,7 +150,7 @@ Test Suite Passed

It is also possible to run just the sanity tests until one of them fails:

``` sh
``` console
$ REPO_ROOT=`pwd` ginkgo '-focus=sanity' -failFast ./test/e2e/
...
```
Loading

0 comments on commit 48f4ea4

Please sign in to comment.