From 52cada531d633af453deed38b538c29cf09b54cf Mon Sep 17 00:00:00 2001 From: Daniel Constantin Date: Fri, 19 Apr 2019 12:18:00 +0300 Subject: [PATCH 1/2] Add CLI -> IPFS docs --- website/scripts/sync-cli-docs.js | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/website/scripts/sync-cli-docs.js b/website/scripts/sync-cli-docs.js index 5fe16111..02f08364 100644 --- a/website/scripts/sync-cli-docs.js +++ b/website/scripts/sync-cli-docs.js @@ -34,6 +34,13 @@ const pages = [ sidebarLabel: 'DAO commands', contentURL: `${BASE_CONTENT_URL}/Dao-commands.md` }, + { + fileLocation: '/docs/cli-ipfs-commands.md', + id: 'cli-ipfs-commands', + title: 'IPFS commands', + sidebarLabel: 'IPFS commands', + contentURL: `${BASE_CONTENT_URL}/Ipfs-commands.md` + }, { fileLocation: '/docs/cli-global-confg.md', id: 'cli-global-confg', From 60d2cbd069bfe17ef2e6b942ec3254d930b6dfbc Mon Sep 17 00:00:00 2001 From: Gabriel Date: Fri, 19 Apr 2019 13:38:01 -0300 Subject: [PATCH 2/2] Fix: add sideback link --- website/i18n/en.json | 255 ++++++++++++++++++++++--------- website/scripts/sync-cli-docs.js | 16 +- website/sidebars.json | 1 + 3 files changed, 188 insertions(+), 84 deletions(-) diff --git a/website/i18n/en.json b/website/i18n/en.json index 5b7cbf8e..1cd8a061 100644 --- a/website/i18n/en.json +++ b/website/i18n/en.json @@ -4,82 +4,185 @@ "next": "Next", "previous": "Previous", "tagline": "What you need to get started building with Aragon", - "acl-intro": "Permissions", - "Permissions": "Permissions", - "apm-ref": "aragonPM reference documentation", - "Reference documentation": "Reference documentation", - "apm": "aragonPM", - "Architecture": "Architecture", - "app-center-preparing-assets": "App Center", - "Preparing assets": "Preparing assets", - "cli-apm-commands": "aragonPM commands", - "aragonPM commands": "aragonPM commands", - "cli-dao-commands": "DAO commands", - "DAO commands": "DAO commands", - "cli-global-confg": "Global configuration", - "Global configuration": "Global configuration", - "cli-intro": "Using the aragonCLI", - "Introduction": "Introduction", - "cli-main-commands": "Main commands", - "Main commands": "Main commands", - "client": "The Aragon client", - "The Aragon client": "The Aragon client", - "forwarding-intro": "Forwarding", - "Forwarding": "Forwarding", - "getting-started": "Getting started", - "Getting started": "Getting started", - "glossary": "Glossary", - "Glossary": "Glossary", - "guides-custom-deploy": "Custom Aragon Organization Deployment using aragonCLI", - "Custom deploy with aragonCLI": "Custom deploy with aragonCLI", - "guides-faq": "Troubleshooting and FAQ", - "Troubleshooting": "Troubleshooting", - "guides-publish": "Publish", - "Publish": "Publish", - "guides-use-frame": "How to use Frame", - "How to use Frame": "How to use Frame", - "human-readable-txs": "Human readable transactions", - "Human readable transactions": "Human readable transactions", - "aragonjs-guide-bg-scripts": "aragonAPI - Background Scripts", - "Background Scripts": "Background Scripts", - "aragonjs-intro": "aragonAPI - Introduction", - "aragonjs-ref-app": "aragonAPI - App", - "App": "App", - "aragonjs-ref-providers": "aragonAPI - Providers", - "Providers": "Providers", - "aragonjs-ref-wrapper": "aragonAPI - Wrapper", - "Wrapper": "Wrapper", - "kits-intro": "Kits", - "Kits": "Kits", - "aragonos-3-ref": "aragonOS 3 reference documentation", - "Reference (aragonOS 3)": "Reference (aragonOS 3)", - "aragonos-4-migration": "aragonOS 4 migration guide", - "Migrating to aragonOS 4 from aragonOS 3": "Migrating to aragonOS 4 from aragonOS 3", - "aragonos-building": "Developing with aragonOS", - "aragonos-intro": "aragonOS intro", - "aragonos-motivation": "Motivations", - "Motivations": "Motivations", - "aragonos-ref": "aragonOS reference documentation", - "package-management": "Package management", - "Package management": "Package management", - "stack": "The Aragon stack", - "The stack": "The stack", - "tutorial": "Your first Aragon app", - "Your first Aragon app": "Your first Aragon app", - "aragonui-intro": "aragonUI intro", - "upgradeability-intro": "Upgradeability", - "Upgradeability": "Upgradeability", - "Get started": "Get started", - "Tutorial": "Tutorial", - "aragonOS": "aragonOS", - "aragonAPI": "aragonAPI", - "aragonUI": "aragonUI", - "Help": "Help", - "The basics": "The basics", - "Guides": "Guides", - "aragonCLI": "aragonCLI", - "aragonPM": "aragonPM", - "App Center": "App Center" + "docs": { + "acl-intro": { + "title": "Permissions", + "sidebar_label": "Permissions" + }, + "api-intro": { + "title": "aragonAPI Introduction", + "sidebar_label": "Introduction" + }, + "aragonjs-quick-start": { + "title": "Quick Start", + "sidebar_label": "Quick Start" + }, + "apm-ref": { + "title": "aragonPM reference documentation", + "sidebar_label": "Reference documentation" + }, + "apm": { + "title": "aragonPM", + "sidebar_label": "Architecture" + }, + "app-center-preparing-assets": { + "title": "App Center", + "sidebar_label": "Preparing assets" + }, + "cli-apm-commands": { + "title": "aragonPM commands", + "sidebar_label": "APM commands" + }, + "cli-dao-commands": { + "title": "DAO commands", + "sidebar_label": "DAO commands" + }, + "cli-global-confg": { + "title": "Global configuration", + "sidebar_label": "Global configuration" + }, + "cli-intro": { + "title": "Using the aragonCLI", + "sidebar_label": "Introduction" + }, + "cli-ipfs-commands": { + "title": "IPFS commands", + "sidebar_label": "IPFS commands" + }, + "cli-main-commands": { + "title": "Main commands", + "sidebar_label": "Main commands" + }, + "client": { + "title": "The Aragon client", + "sidebar_label": "The Aragon client" + }, + "forwarding-intro": { + "title": "Forwarding", + "sidebar_label": "Forwarding" + }, + "getting-started": { + "title": "Getting started", + "sidebar_label": "Getting started" + }, + "glossary": { + "title": "Glossary", + "sidebar_label": "Glossary" + }, + "guides-custom-deploy": { + "title": "Custom Deploy", + "sidebar_label": "Custom deploy with aragonCLI" + }, + "guides-faq": { + "title": "Troubleshooting and FAQ", + "sidebar_label": "Troubleshooting" + }, + "guides-publish": { + "title": "Publish", + "sidebar_label": "Publish" + }, + "guides-use-frame": { + "title": "How to use Frame", + "sidebar_label": "How to use Frame" + }, + "human-readable-txs": { + "title": "Human readable transactions", + "sidebar_label": "Human readable transactions" + }, + "aragonjs-guide-bg-scripts": { + "title": "Background Scripts", + "sidebar_label": "Background Scripts" + }, + "aragonjs-ref-app": { + "title": "aragonAPI for Javascript", + "sidebar_label": "App API" + }, + "aragonjs-ref-architecture": { + "title": "aragonAPI for architecture", + "sidebar_label": "Architecture of apps" + }, + "aragonjs-ref-hooks": { + "title": "aragonJS - React Hooks", + "sidebar_label": "React Hooks" + }, + "aragonjs-ref-providers": { + "title": "aragonAPI for providers", + "sidebar_label": "Providers" + }, + "aragonjs-ref-react": { + "title": "aragonAPI for React", + "sidebar_label": "React API" + }, + "aragonjs-ref-wrapper": { + "title": "aragonAPI for wrapper", + "sidebar_label": "Wrapper" + }, + "aragonos-3-ref": { + "title": "aragonOS 3 reference documentation", + "sidebar_label": "Reference (aragonOS 3)" + }, + "aragonos-4-migration": { + "title": "aragonOS 4 migration guide", + "sidebar_label": "Migrating to aragonOS 4 from aragonOS 3" + }, + "aragonos-building": { + "title": "Developing with aragonOS" + }, + "aragonos-intro": { + "title": "aragonOS intro", + "sidebar_label": "Introduction" + }, + "aragonos-motivation": { + "title": "Motivations", + "sidebar_label": "Motivations" + }, + "aragonos-ref": { + "title": "aragonOS reference documentation", + "sidebar_label": "Reference documentation" + }, + "package-management": { + "title": "Package management", + "sidebar_label": "Package management" + }, + "stack": { + "title": "The Aragon stack", + "sidebar_label": "The stack" + }, + "templates-intro": { + "title": "Templates", + "sidebar_label": "Templates" + }, + "tutorial": { + "title": "Your first Aragon app", + "sidebar_label": "Your first Aragon app" + }, + "aragonui-intro": { + "title": "aragonUI intro", + "sidebar_label": "Introduction" + }, + "upgradeability-intro": { + "title": "Upgradeability", + "sidebar_label": "Upgradeability" + } + }, + "links": { + "Get started": "Get started", + "Tutorial": "Tutorial", + "aragonOS": "aragonOS", + "aragonAPI": "aragonAPI", + "aragonUI": "aragonUI", + "Help": "Help" + }, + "categories": { + "The basics": "The basics", + "Guides": "Guides", + "aragonCLI": "aragonCLI", + "aragonPM": "aragonPM", + "aragonOS": "aragonOS", + "aragonAPI": "aragonAPI", + "aragonUI": "aragonUI", + "App Center": "App Center" + } }, "pages-strings": { "Help Translate|recruit community translators for your project": "Help Translate", diff --git a/website/scripts/sync-cli-docs.js b/website/scripts/sync-cli-docs.js index 02f08364..3f17ce0f 100644 --- a/website/scripts/sync-cli-docs.js +++ b/website/scripts/sync-cli-docs.js @@ -11,43 +11,43 @@ const pages = [ title: 'Using the aragonCLI', sidebarLabel: 'Introduction', hideTitle: true, - contentURL: `${BASE_CONTENT_URL}/Intro.md` + contentURL: `${BASE_CONTENT_URL}/Intro.md`, }, { fileLocation: '/docs/cli-main-commands.md', id: 'cli-main-commands', title: 'Main commands', sidebarLabel: 'Main commands', - contentURL: `${BASE_CONTENT_URL}/Main-commands.md` + contentURL: `${BASE_CONTENT_URL}/Main-commands.md`, }, { fileLocation: '/docs/cli-apm-commands.md', id: 'cli-apm-commands', title: 'aragonPM commands', - sidebarLabel: 'aragonPM commands', - contentURL: `${BASE_CONTENT_URL}/Apm-commands.md` + sidebarLabel: 'APM commands', + contentURL: `${BASE_CONTENT_URL}/Apm-commands.md`, }, { fileLocation: '/docs/cli-dao-commands.md', id: 'cli-dao-commands', title: 'DAO commands', sidebarLabel: 'DAO commands', - contentURL: `${BASE_CONTENT_URL}/Dao-commands.md` + contentURL: `${BASE_CONTENT_URL}/Dao-commands.md`, }, { fileLocation: '/docs/cli-ipfs-commands.md', id: 'cli-ipfs-commands', title: 'IPFS commands', sidebarLabel: 'IPFS commands', - contentURL: `${BASE_CONTENT_URL}/Ipfs-commands.md` + contentURL: `${BASE_CONTENT_URL}/Ipfs-commands.md`, }, { fileLocation: '/docs/cli-global-confg.md', id: 'cli-global-confg', title: 'Global configuration', sidebarLabel: 'Global configuration', - contentURL: `${BASE_CONTENT_URL}/Global-confg.md` - } + contentURL: `${BASE_CONTENT_URL}/Global-confg.md`, + }, ] const locationReferenceMap = {} diff --git a/website/sidebars.json b/website/sidebars.json index 2d837736..b9cdab94 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -23,6 +23,7 @@ "cli-main-commands", "cli-dao-commands", "cli-apm-commands", + "cli-ipfs-commands", "cli-global-confg" ], "aragonPM": ["apm", "apm-ref"],