From c4b3015a0f755be8e4cb627c417c0035b769139c Mon Sep 17 00:00:00 2001 From: Anna Dunster Date: Tue, 23 Feb 2021 18:50:01 -0800 Subject: [PATCH 1/2] Add Project specific titles to contributing and grammar docs --- CONTRIBUTING.md | 6 ++++++ docs/community/contribute/grammar-formatting-and-style.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 69d2f77ee..085a5451a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,6 +62,12 @@ Write everything in using the [GitHub Flavored Markdown](https://github.github.c > > Dealing with the James Harden effect +### Project specific titles + +When referring to projects by name, use proper noun capitalization: Go-IPFS and JS-IPFS. + +Cases inside code blocks refer to commands and are not capitalized: `go-ifps` or `js-ifps`. + ### Style and tone When writing content to explain a particular workflow, function, or service, keep your tone clean and straightforward. While it doesn't have to be formal, technical writing is not creative writing. You're just explaining to the reader how to _do_ something. diff --git a/docs/community/contribute/grammar-formatting-and-style.md b/docs/community/contribute/grammar-formatting-and-style.md index d83e52dc2..088c2110c 100755 --- a/docs/community/contribute/grammar-formatting-and-style.md +++ b/docs/community/contribute/grammar-formatting-and-style.md @@ -34,6 +34,12 @@ If you have to use an acronym, spell the full phrase first and include the acron > Virtual Machine (VM), Decentralized Web (DWeb). +### Project specific titles + +When referring to projects by name, use proper noun capitalization: Go-IPFS and JS-IPFS. + +Cases inside code blocks refer to commands and are not capitalized: `go-ifps` or `js-ifps`. + ## Formatting How the Markdown syntax looks, and code formatting rules to follow. From 66f00c8da37f5909a5836a41c3ac9c830af99056 Mon Sep 17 00:00:00 2001 From: Mark Shachkov Date: Wed, 24 Feb 2021 21:14:14 +0300 Subject: [PATCH 2/2] Fix downloaded filename for linux ipfs-updater --- docs/install/ipfs-updater.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/ipfs-updater.md b/docs/install/ipfs-updater.md index 3a9810f8a..5d6c75a45 100644 --- a/docs/install/ipfs-updater.md +++ b/docs/install/ipfs-updater.md @@ -129,7 +129,7 @@ You can download pre-built binaries from [`dist.ipfs.io`](https://dist.ipfs.io/# 2. Unzip the file: ```bash - tar -xvzf ipfs-update_v1.6.0_darwin-amd64.tar.gz + tar -xvzf ipfs-update_v1.6.0_linux-amd64.tar.gz > x ipfs-update/install.sh > x ipfs-update/ipfs-update