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

Commit 48f4ea4

Browse files
Hard coded release version for sphinx-copybutton and updated code blocks to use console and ShellSession where required.
Signed-off-by: Kevin Putnam <[email protected]>
1 parent 313419b commit 48f4ea4

File tree

8 files changed

+169
-160
lines changed

8 files changed

+169
-160
lines changed

docs/DEVELOPMENT.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -341,23 +341,23 @@ pkg/pmem-registry/pmem-registry.pb.go is generated from pkg/pmem-registry/pmem-r
341341

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

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

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

355355
### Table of Contents in README and DEVELOPMENT
356356

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

360-
```sh
360+
``` console
361361
$ pandoc -s -t markdown_github --toc README.md -o /tmp/temp.md
362362
```
363363

@@ -379,8 +379,8 @@ theme.
379379

380380
Building the documentation requires Python 3.x and venv.
381381

382-
```bash
383-
make vhtml
382+
``` console
383+
$ make vhtml
384384
```
385385

386386
### Edit

docs/autotest.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ the default `pmem-govm` cluster name via the `CLUSTER` env variable.
109109
For example, this invocation sets up a cluster using the non-default
110110
Fedora distro:
111111

112-
``` sh
112+
```
113113
TEST_DISTRO=fedora CLUSTER=fedora-govm make start
114114
```
115115

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

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

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

153-
``` sh
153+
``` console
154154
$ REPO_ROOT=`pwd` ginkgo '-focus=sanity' -failFast ./test/e2e/
155155
...
156156
```

0 commit comments

Comments
 (0)