Skip to content

Commit 7591e6a

Browse files
committed
Create and highlight code blocks
1 parent 99a6d1c commit 7591e6a

File tree

6 files changed

+35
-16
lines changed

6 files changed

+35
-16
lines changed

docs/API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ By passing an `order_by` parameter you can order the data by the provided key. E
8080

8181
#### Example Request
8282

83-
```
83+
```shell
8484
~ % curl "https://gitcoin.co/api/v0.1/bounties/?&order_by=web3_created"
8585

8686
[
@@ -123,7 +123,7 @@ By passing an `order_by` parameter you can order the data by the provided key. E
123123

124124
You may interact with the HTTPS API as follows
125125

126-
```
126+
```shell
127127
truffle(development)> BountyIndex.at('0x0ed0c2a859e9e576cdff840c51d29b6f8a405bdd').bountydetails.call('https://github.com/owocki/pytrader/pull/83');
128128
[ { [String: '100000000000000000'] s: 1, e: 17, c: [ 1000 ] },
129129
'0x0000000000000000000000000000000000000000',

docs/KUBE.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,73 @@
22

33
## install
44

5+
```shell
56
brew update
7+
```
8+
69
### install kubectl and AWS
10+
```shell
711
brew install kubernetes-cli
812
brew install aws-cli
913
brew install aws
1014
brew link kubernetes-cli
15+
```
1116

1217
### install aws-iam-authenticator
18+
```shell
1319
curl -o aws-iam-authenticator https://amazon-eks.s3-us-west-2.amazonaws.com/1.11.5/2018-12-06/bin/darwin/amd64/aws-iam-authenticator

20+
```
21+
1422
# mv to your path
1523

1624
aws configure
1725
### enter your path
1826

1927
### completion
2028
### https://kubernetes.io/docs/tasks/tools/install-kubectl
21-
awscli
us-west-2
kubectl completion bash > $(brew --prefix)/etc/bash_completion.d/kubectl
29+
```shell
30+
awsclius-west-2kubectl completion bash > $(brew --prefix)/etc/bash_completion.d/kubectl
31+
```
2232

2333
### now you can use kubecontrol. our cluster uses 1.10
2434

2535
# using it
2636

37+
```shell
2738
kubectl config get-contexts
2839
kubectl config use-context
40+
```
2941

3042

3143
## using the proxy
44+
```shell
3245
kubectl proxy
46+
```
3347

3448
## you can now go to
3549
http://localhost:8001/api/v1/namespaces/kube-system/services/https:kubernetes-dashboard:/proxy/#!/login
3650

3751

3852
# exec into a pod
3953

54+
```shell
4055
kubectl exec <pod-name> <command> --namespace=<namespace>
4156
kubectl exec prometheus-op-kube-state-metrics-85b7ffcb89-s96z7 /bin/bash --namespace=monitoring
57+
```
4258

4359
# other tools
4460

4561
https://gam.gitcoin.co/login
4662
http://grafana.com/dashboards
4763
prometheus -- out of the box alerts /logs
4864
did you know that you can run your standard docker commands in kubectl? neato
49-
kubectl get pods --namespace=gc-production
50-
kubectl get services --namespace=monitoring
51-
kbuectl get ingress web --namespace notifications
65+
66+
```shell
67+
kubectl get pods --namespace=gc-production
68+
kubectl get services --namespace=monitoring
69+
kbuectl get ingress web --namespace notifications
70+
```
71+
5272
http://github.com/helm
5373
predefined deployments you can use.
5474
ingress docs => https://kubernetes.io/docs/concepts/services-networking/ingress/

docs/KUDOS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
First be aware to update your `.env` with this entries
66

7-
```
7+
```shell
88
KUDOS_NETWORK=rinkeby
99
KUDOS_OWNER_ACCOUNT= YOUR_ADDRESS
1010
KUDOS_LOCAL_SYNC=off

docs/STYLEGUIDE.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ _Note: All pages within gitcoin are expected to reuse these classes as applicabl
2020
### Mutiselect (using select2)
2121

2222
_usage_
23-
```
23+
```html
2424
<div class="form__select2 g-multiselect">
2525
<select class="js-select2" multiple>
2626
</select>
@@ -35,17 +35,16 @@ The Multiselect styling used in Gitcoin can be found in
3535
_usage_
3636

3737

38-
```
38+
```html
3939
<script src="{% static 'v2/js/clipboard.js' %}"></script>
4040
```
4141

42-
```
42+
```html
4343
<textarea id="matchid">This text will be copied</textarea>
4444
<button data-copyclipboard="#matchid">Copy Text</button>
4545
```
4646
_usage with class_
47-
```
48-
47+
```html
4948
<input type="text" class="matchclass" value="This text will be copied">
5049
<button data-copyclipboard=".matchclass">Copy Text</button>
5150
```
@@ -54,7 +53,7 @@ _Note: You can use it with `textarea` or `input` elements._
5453
### Slider
5554

5655
_usage_
57-
```
56+
```html
5857
<label class="g-switch">
5958
<input id="package-period" type="checkbox">
6059
<span class="slider"></span>

docs/THIRD_PARTY_SETUP.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ SENDGRID_API_KEY=xxx
5050
CONTACT_EMAIL=xxx
5151
```
5252

53-
```
53+
```shell
5454
# Be VERY CAREFUL when changing this setting. You don't want to accidently
5555
# send a bunch of github notifications :)
5656
ENABLE_NOTIFICATIONS_ON_NETWORK=None
@@ -65,7 +65,7 @@ Copy the application ID found on the page as the `GITCOINBOT_APP_ID` environment
6565

6666
Make sure you disable gitcoinbot notifications on your local, unless you are specifically testing that feature
6767

68-
```
68+
```shell
6969
# Be VERY CAREFUL when changing this setting. You don't want to accidentally
7070
# send a bunch of github notifications :)
7171
ENABLE_NOTIFICATIONS_ON_NETWORK=None

docs/WIDGET.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Repos that have this widget can expect to see 35% more interest in their repo's
9797
### Code
9898

9999
Place the following code into your repo readme:
100-
```
100+
```html
101101
<a href="https://gitcoin.co/explorer?q=YOUR_REPO_NAME">
102102
<img src="https://gitcoin.co/funding/embed?repo=https://github.com/YOUR_ORG_NAME/YOUR_REPO_NAME">
103103
</a>

0 commit comments

Comments
 (0)