Skip to content

Commit 1adb217

Browse files
Working push.
1 parent 1c78e6c commit 1adb217

22 files changed

+650
-1123
lines changed

Diff for: .circleci/config.yml

+58-58
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,58 @@
1-
version: 2
2-
jobs:
3-
build:
4-
docker:
5-
- image: circleci/node:10.15.1-browsers
6-
environment:
7-
NO_SANDBOX: true
8-
steps:
9-
- checkout
10-
- run:
11-
name: update-npm
12-
command: 'sudo npm install -g npm@latest'
13-
- restore_cache:
14-
key: dependency-cache-{{ checksum "package-lock.json" }}
15-
- run:
16-
name: install-npm
17-
command: npm install
18-
- save_cache:
19-
key: dependency-cache-{{ checksum "package-lock.json" }}
20-
paths:
21-
- ./node_modules
22-
- run:
23-
name: build-docs
24-
command: npm run docs:build
25-
- persist_to_workspace:
26-
root: .
27-
paths:
28-
- ./docs/.vuepress/dist
29-
30-
deploy:
31-
docker:
32-
- image: olizilla/ipfs-dns-deploy:debug
33-
environment:
34-
DOMAIN: docs.ipfs.io
35-
BUILD_DIR: ./docs/.vuepress/dist
36-
CLUSTER_HOST: /dnsaddr/ipfs-websites.collab.ipfscluster.io
37-
steps:
38-
- attach_workspace:
39-
at: /tmp/workspace
40-
- run:
41-
name: Deploy website to IPFS
42-
command: |
43-
pin_name="$DOMAIN build $CIRCLE_BUILD_NUMBER"
44-
hash=$(pin-to-cluster.sh "$pin_name" /tmp/workspace/$BUILD_DIR)
45-
echo "Website added to IPFS: https://ipfs.io/ipfs/$hash"
46-
# Update DNSlink
47-
if [ "$CIRCLE_BRANCH" == "master" ] ; then
48-
dnslink-dnsimple -d $DOMAIN -r _dnslink -l /ipfs/$hash
49-
fi
50-
workflows:
51-
version: 2
52-
build-deploy:
53-
jobs:
54-
- build
55-
- deploy:
56-
context: ipfs-dns-deploy
57-
requires:
58-
- build
1+
version: 2
2+
jobs:
3+
build:
4+
docker:
5+
- image: circleci/node:10.15.1-browsers
6+
environment:
7+
NO_SANDBOX: true
8+
steps:
9+
- checkout
10+
- run:
11+
name: update-npm
12+
command: 'sudo npm install -g npm@latest'
13+
- restore_cache:
14+
key: dependency-cache-{{ checksum "package-lock.json" }}
15+
- run:
16+
name: install-npm
17+
command: npm install
18+
- save_cache:
19+
key: dependency-cache-{{ checksum "package-lock.json" }}
20+
paths:
21+
- ./node_modules
22+
- run:
23+
name: build-docs
24+
command: npm run docs:build
25+
- persist_to_workspace:
26+
root: .
27+
paths:
28+
- ./docs/.vuepress/dist
29+
30+
deploy:
31+
docker:
32+
- image: olizilla/ipfs-dns-deploy:debug
33+
environment:
34+
DOMAIN: docs.ipfs.io
35+
BUILD_DIR: ./docs/.vuepress/dist
36+
CLUSTER_HOST: /dnsaddr/ipfs-websites.collab.ipfscluster.io
37+
steps:
38+
- attach_workspace:
39+
at: /tmp/workspace
40+
- run:
41+
name: Deploy website to IPFS
42+
command: |
43+
pin_name="$DOMAIN build $CIRCLE_BUILD_NUMBER"
44+
hash=$(pin-to-cluster.sh "$pin_name" /tmp/workspace/$BUILD_DIR)
45+
echo "Website added to IPFS: https://ipfs.io/ipfs/$hash"
46+
# Update DNSlink
47+
if [ "$CIRCLE_BRANCH" == "master" ] ; then
48+
dnslink-dnsimple -d $DOMAIN -r _dnslink -l /ipfs/$hash
49+
fi
50+
workflows:
51+
version: 2
52+
build-deploy:
53+
jobs:
54+
- build
55+
- deploy:
56+
context: ipfs-dns-deploy
57+
requires:
58+
- build

Diff for: .github/ISSUE_TEMPLATE/open_an_issue.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ about: Only for actionable issues relevant to this repository.
44
title: ''
55
labels: need/triage
66
assignees: ''
7-
87
---
8+
99
<!--
1010
Hello! To ensure this issue is correctly addressed as soon as possible by the IPFS team, please try to make sure that you describe your suggestion in as much detail as possible. If you have any images or sketches to go along with the suggestion, please include them here.
1111
-->

Diff for: .github/ISSUE_TEMPLATE/suggestion.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ about: Have an idea of something new you'd like to see in the docs? Suggest it u
44
title: ''
55
labels: need/triage, kind/suggestion
66
assignees: ''
7-
87
---
8+
99
<!--
1010
Hello! To ensure this issue is correctly addressed as soon as possible by the IPFS team, please try to make sure that you describe your suggestion in as much detail as possible. If you have any images or sketches to go along with the suggestion, please include them here.
1111
-->

Diff for: .github/config.yml

+47-47
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,47 @@
1-
blank_issues_enabled: false
2-
3-
# Configuration for welcome - https://github.com/behaviorbot/welcome
4-
5-
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
6-
# Comment to be posted to on first time issues
7-
newIssueWelcomeComment: >
8-
Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review.
9-
10-
In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additiona round trips is useful! We currently aim to give initial feedback within **two business days**. If this does not happen, feel free to leave a comment.
11-
12-
Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:
13-
14-
- "Priority" labels will show how urgent this is for the team.
15-
- "Status" labels will show if this is ready to be worked on, blocked, or in progress.
16-
- "Need" labels will indicate if additional input or analysis is required.
17-
18-
Finally, remember to use https://discuss.ipfs.io if you just need general support.
19-
20-
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
21-
# Comment to be posted to on PRs from first time contributors in your repository
22-
newPRWelcomeComment: >
23-
Thank you for submitting this PR!
24-
25-
A maintainer will be here shortly to review it.
26-
27-
We are super grateful, but we are also overloaded! Help us by making sure that:
28-
29-
- The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned.
30-
- Your contribution itself is clear (grammar and spelling checked, any code blocks checked and commented) and in its best form. Follow the [docs contribution guidelines](https://github.com/ipfs/ipfs-docs/blob/master/CONTRIBUTING.md) if they apply.
31-
32-
Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
33-
34-
Next steps:
35-
36-
- A maintainer will triage and assign priority to this PR, commenting on any missing things and potentially assigning a reviewer for high priority items.
37-
- The PR gets reviews, discussed and approvals as needed.
38-
- The PR is merged by maintainers when it has been approved and comments addressed.
39-
40-
We currently aim to provide initial feedback/triaging within **two business days**. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
41-
42-
We are very grateful for your contribution!
43-
44-
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
45-
# Comment to be posted to on pull requests merged by a first time user
46-
# Currently disabled
47-
#firstPRMergeComment: ""
1+
blank_issues_enabled: false
2+
3+
# Configuration for welcome - https://github.com/behaviorbot/welcome
4+
5+
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
6+
# Comment to be posted to on first time issues
7+
newIssueWelcomeComment: >
8+
Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review.
9+
10+
In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additiona round trips is useful! We currently aim to give initial feedback within **two business days**. If this does not happen, feel free to leave a comment.
11+
12+
Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:
13+
14+
- "Priority" labels will show how urgent this is for the team.
15+
- "Status" labels will show if this is ready to be worked on, blocked, or in progress.
16+
- "Need" labels will indicate if additional input or analysis is required.
17+
18+
Finally, remember to use https://discuss.ipfs.io if you just need general support.
19+
20+
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
21+
# Comment to be posted to on PRs from first time contributors in your repository
22+
newPRWelcomeComment: >
23+
Thank you for submitting this PR!
24+
25+
A maintainer will be here shortly to review it.
26+
27+
We are super grateful, but we are also overloaded! Help us by making sure that:
28+
29+
- The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned.
30+
- Your contribution itself is clear (grammar and spelling checked, any code blocks checked and commented) and in its best form. Follow the [docs contribution guidelines](https://github.com/ipfs/ipfs-docs/blob/master/CONTRIBUTING.md) if they apply.
31+
32+
Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
33+
34+
Next steps:
35+
36+
- A maintainer will triage and assign priority to this PR, commenting on any missing things and potentially assigning a reviewer for high priority items.
37+
- The PR gets reviews, discussed and approvals as needed.
38+
- The PR is merged by maintainers when it has been approved and comments addressed.
39+
40+
We currently aim to provide initial feedback/triaging within **two business days**. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
41+
42+
We are very grateful for your contribution!
43+
44+
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
45+
# Comment to be posted to on pull requests merged by a first time user
46+
# Currently disabled
47+
#firstPRMergeComment: ""

Diff for: .gitignore

+14-14
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# fs & dev
2-
.DS_Store
3-
node_modules
4-
dist
5-
.temp
6-
7-
# logs
8-
logs
9-
*.log
10-
npm-debug.log*
11-
yarn-debug.log*
12-
yarn-error.log*
13-
14-
# editor
1+
# fs & dev
2+
.DS_Store
3+
node_modules
4+
dist
5+
.temp
6+
7+
# logs
8+
logs
9+
*.log
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
14+
# editor
1515
.vscode

Diff for: docs/.vuepress/public/browserconfig.xml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
<?xml version="1.0" encoding="utf-8"?>
2-
<browserconfig>
3-
<msapplication>
4-
<tile>
5-
<square150x150logo src="/mstile-150x150.png"/>
6-
<TileColor>#00aba9</TileColor>
7-
</tile>
8-
</msapplication>
9-
</browserconfig>
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<browserconfig>
3+
<msapplication>
4+
<tile>
5+
<square150x150logo src="/mstile-150x150.png"/>
6+
<TileColor>#00aba9</TileColor>
7+
</tile>
8+
</msapplication>
9+
</browserconfig>

Diff for: docs/.vuepress/public/manifest.json

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
{
2-
"name": "",
3-
"short_name": "",
4-
"icons": [
5-
{
6-
"src": "/android-chrome-192x192.png",
7-
"sizes": "192x192",
8-
"type": "image/png"
9-
},
10-
{
11-
"src": "/android-chrome-256x256.png",
12-
"sizes": "256x256",
13-
"type": "image/png"
14-
}
15-
],
16-
"theme_color": "#ffffff",
17-
"background_color": "#ffffff",
18-
"display": "standalone"
2+
"name": "",
3+
"short_name": "",
4+
"icons": [
5+
{
6+
"src": "/android-chrome-192x192.png",
7+
"sizes": "192x192",
8+
"type": "image/png"
9+
},
10+
{
11+
"src": "/android-chrome-256x256.png",
12+
"sizes": "256x256",
13+
"type": "image/png"
14+
}
15+
],
16+
"theme_color": "#ffffff",
17+
"background_color": "#ffffff",
18+
"display": "standalone"
1919
}

Diff for: docs/.vuepress/redirects

+37-37
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
1-
/introduction/ /concepts/
2-
/introduction/overview/ /concepts/what-is-ipfs/
3-
/introduction/how-ipfs-works/ /concepts/how-ipfs-works/
4-
/introduction/usage/ /how-to/command-line-quick-start/
5-
/introduction/faq/ /concepts/faq/
6-
/guides/ /how-to/
7-
/guides/concepts/ /concepts/
8-
/guides/concepts/cid/ /concepts/content-addressing/
9-
/guides/concepts/dht/ /concepts/dht/
10-
/guides/concepts/dnslink/ /concepts/dnslink/
11-
/guides/concepts/hashes/ /concepts/hashing/
12-
/guides/concepts/ipns/ /concepts/ipns/
13-
/guides/concepts/merkle-dag/ /concepts/merkle-dag/
14-
/guides/concepts/mfs/ /concepts/file-systems/
15-
/guides/concepts/pinning/ /concepts/persistence/
16-
/guides/concepts/unixfs/ /concepts/file-systems/
17-
/guides/guides/install/ /install/
18-
/guides/guides/addressing/ /how-to/address-ipfs-on-web/
19-
/guides/examples/ /how-to/
20-
/guides/examples/config/ /how-to/configure-node/
21-
/guides/examples/blocks/ /how-to/work-with-blocks/
22-
/guides/examples/git/ /how-to/host-git-style-repo/
23-
/guides/examples/websites/ /how-to/websites-on-ipfs/single-page-website/
24-
/guides/examples/bootstrap/ /how-to/modify-bootstrap-list/
25-
/guides/examples/pinning/ /how-to/pin-files/
26-
/guides/examples/videos/ /how-to/store-play-videos/
27-
/guides/examples/network/ /how-to/observe-peers/
28-
/guides/examples/snapshots/ /how-to/take-snapshot/
29-
/guides/examples/api/service/readme/ /how-to/make-service/
30-
/how-to/host-single-page-site /how-to/websites-on-ipfs/single-page-website
31-
/reference/api/ /reference/
32-
/reference/api/cli/ /reference/cli/
33-
/reference/api/http/ /reference/http/api/
34-
/reference/go/overview/ /reference/go/api/
35-
/reference/js/overview/ /reference/js/api/
36-
/community/contribute/ /project/contribute/
37-
/community/contribute/how-to-help/ /project/contribute/
1+
/introduction/ /concepts/
2+
/introduction/overview/ /concepts/what-is-ipfs/
3+
/introduction/how-ipfs-works/ /concepts/how-ipfs-works/
4+
/introduction/usage/ /how-to/command-line-quick-start/
5+
/introduction/faq/ /concepts/faq/
6+
/guides/ /how-to/
7+
/guides/concepts/ /concepts/
8+
/guides/concepts/cid/ /concepts/content-addressing/
9+
/guides/concepts/dht/ /concepts/dht/
10+
/guides/concepts/dnslink/ /concepts/dnslink/
11+
/guides/concepts/hashes/ /concepts/hashing/
12+
/guides/concepts/ipns/ /concepts/ipns/
13+
/guides/concepts/merkle-dag/ /concepts/merkle-dag/
14+
/guides/concepts/mfs/ /concepts/file-systems/
15+
/guides/concepts/pinning/ /concepts/persistence/
16+
/guides/concepts/unixfs/ /concepts/file-systems/
17+
/guides/guides/install/ /install/
18+
/guides/guides/addressing/ /how-to/address-ipfs-on-web/
19+
/guides/examples/ /how-to/
20+
/guides/examples/config/ /how-to/configure-node/
21+
/guides/examples/blocks/ /how-to/work-with-blocks/
22+
/guides/examples/git/ /how-to/host-git-style-repo/
23+
/guides/examples/websites/ /how-to/websites-on-ipfs/single-page-website/
24+
/guides/examples/bootstrap/ /how-to/modify-bootstrap-list/
25+
/guides/examples/pinning/ /how-to/pin-files/
26+
/guides/examples/videos/ /how-to/store-play-videos/
27+
/guides/examples/network/ /how-to/observe-peers/
28+
/guides/examples/snapshots/ /how-to/take-snapshot/
29+
/guides/examples/api/service/readme/ /how-to/make-service/
30+
/how-to/host-single-page-site /how-to/websites-on-ipfs/single-page-website
31+
/reference/api/ /reference/
32+
/reference/api/cli/ /reference/cli/
33+
/reference/api/http/ /reference/http/api/
34+
/reference/go/overview/ /reference/go/api/
35+
/reference/js/overview/ /reference/js/api/
36+
/community/contribute/ /project/contribute/
37+
/community/contribute/how-to-help/ /project/contribute/
3838
/install/command-line-quick-start/ /how-to/command-line-quick-start/

0 commit comments

Comments
 (0)