From 392b83fc4bf6754feb5fd817544614e5413ff2e6 Mon Sep 17 00:00:00 2001 From: aleksa-krolls Date: Wed, 29 Nov 2023 19:43:22 +0200 Subject: [PATCH 01/11] renaming contribute section --- docs/{contributing => contribute}/openfn-roadmap.md | 0 docs/{contributing => contribute}/roadmap.md | 0 docs/{contributing => contribute}/style-guide.md | 0 docs/{contributing => contribute}/writing-code.md | 0 docs/{contributing => contribute}/writing-docs.md | 0 5 files changed, 0 insertions(+), 0 deletions(-) rename docs/{contributing => contribute}/openfn-roadmap.md (100%) rename docs/{contributing => contribute}/roadmap.md (100%) rename docs/{contributing => contribute}/style-guide.md (100%) rename docs/{contributing => contribute}/writing-code.md (100%) rename docs/{contributing => contribute}/writing-docs.md (100%) diff --git a/docs/contributing/openfn-roadmap.md b/docs/contribute/openfn-roadmap.md similarity index 100% rename from docs/contributing/openfn-roadmap.md rename to docs/contribute/openfn-roadmap.md diff --git a/docs/contributing/roadmap.md b/docs/contribute/roadmap.md similarity index 100% rename from docs/contributing/roadmap.md rename to docs/contribute/roadmap.md diff --git a/docs/contributing/style-guide.md b/docs/contribute/style-guide.md similarity index 100% rename from docs/contributing/style-guide.md rename to docs/contribute/style-guide.md diff --git a/docs/contributing/writing-code.md b/docs/contribute/writing-code.md similarity index 100% rename from docs/contributing/writing-code.md rename to docs/contribute/writing-code.md diff --git a/docs/contributing/writing-docs.md b/docs/contribute/writing-docs.md similarity index 100% rename from docs/contributing/writing-docs.md rename to docs/contribute/writing-docs.md From 63fae67808fd2988bca460ba0c7436624a8c11df Mon Sep 17 00:00:00 2001 From: aleksa-krolls Date: Wed, 29 Nov 2023 19:44:36 +0200 Subject: [PATCH 02/11] rename build-for-devs and get-started sections --- docs/{developers => build-for-developers}/build-with-api.md | 0 docs/{developers => build-for-developers}/cli.md | 0 docs/{developers => build-for-developers}/each.md | 0 docs/{developers => build-for-developers}/editing-locally.md | 0 docs/{developers => build-for-developers}/errors.md | 0 docs/{developers => build-for-developers}/for-devs.md | 0 docs/{developers => build-for-developers}/job-design-intro.md | 0 docs/{developers => build-for-developers}/job-studio.md | 0 docs/{developers => build-for-developers}/limits.md | 0 docs/{developers => build-for-developers}/multiple-operations.md | 0 docs/{developers => build-for-developers}/operations.md | 0 docs/{developers => build-for-developers}/state.md | 0 docs/{developers => build-for-developers}/understanding.md | 0 .../{developers => build-for-developers}/working-with-branches.md | 0 docs/{intro => get-started}/home.md | 0 docs/{intro => get-started}/implementation-checklist.md | 0 docs/{intro => get-started}/security-compliance.md | 0 docs/{intro => get-started}/security.md | 0 docs/{intro => get-started}/standards.md | 0 docs/{intro => get-started}/terminology.md | 0 20 files changed, 0 insertions(+), 0 deletions(-) rename docs/{developers => build-for-developers}/build-with-api.md (100%) rename docs/{developers => build-for-developers}/cli.md (100%) rename docs/{developers => build-for-developers}/each.md (100%) rename docs/{developers => build-for-developers}/editing-locally.md (100%) rename docs/{developers => build-for-developers}/errors.md (100%) rename docs/{developers => build-for-developers}/for-devs.md (100%) rename docs/{developers => build-for-developers}/job-design-intro.md (100%) rename docs/{developers => build-for-developers}/job-studio.md (100%) rename docs/{developers => build-for-developers}/limits.md (100%) rename docs/{developers => build-for-developers}/multiple-operations.md (100%) rename docs/{developers => build-for-developers}/operations.md (100%) rename docs/{developers => build-for-developers}/state.md (100%) rename docs/{developers => build-for-developers}/understanding.md (100%) rename docs/{developers => build-for-developers}/working-with-branches.md (100%) rename docs/{intro => get-started}/home.md (100%) rename docs/{intro => get-started}/implementation-checklist.md (100%) rename docs/{intro => get-started}/security-compliance.md (100%) rename docs/{intro => get-started}/security.md (100%) rename docs/{intro => get-started}/standards.md (100%) rename docs/{intro => get-started}/terminology.md (100%) diff --git a/docs/developers/build-with-api.md b/docs/build-for-developers/build-with-api.md similarity index 100% rename from docs/developers/build-with-api.md rename to docs/build-for-developers/build-with-api.md diff --git a/docs/developers/cli.md b/docs/build-for-developers/cli.md similarity index 100% rename from docs/developers/cli.md rename to docs/build-for-developers/cli.md diff --git a/docs/developers/each.md b/docs/build-for-developers/each.md similarity index 100% rename from docs/developers/each.md rename to docs/build-for-developers/each.md diff --git a/docs/developers/editing-locally.md b/docs/build-for-developers/editing-locally.md similarity index 100% rename from docs/developers/editing-locally.md rename to docs/build-for-developers/editing-locally.md diff --git a/docs/developers/errors.md b/docs/build-for-developers/errors.md similarity index 100% rename from docs/developers/errors.md rename to docs/build-for-developers/errors.md diff --git a/docs/developers/for-devs.md b/docs/build-for-developers/for-devs.md similarity index 100% rename from docs/developers/for-devs.md rename to docs/build-for-developers/for-devs.md diff --git a/docs/developers/job-design-intro.md b/docs/build-for-developers/job-design-intro.md similarity index 100% rename from docs/developers/job-design-intro.md rename to docs/build-for-developers/job-design-intro.md diff --git a/docs/developers/job-studio.md b/docs/build-for-developers/job-studio.md similarity index 100% rename from docs/developers/job-studio.md rename to docs/build-for-developers/job-studio.md diff --git a/docs/developers/limits.md b/docs/build-for-developers/limits.md similarity index 100% rename from docs/developers/limits.md rename to docs/build-for-developers/limits.md diff --git a/docs/developers/multiple-operations.md b/docs/build-for-developers/multiple-operations.md similarity index 100% rename from docs/developers/multiple-operations.md rename to docs/build-for-developers/multiple-operations.md diff --git a/docs/developers/operations.md b/docs/build-for-developers/operations.md similarity index 100% rename from docs/developers/operations.md rename to docs/build-for-developers/operations.md diff --git a/docs/developers/state.md b/docs/build-for-developers/state.md similarity index 100% rename from docs/developers/state.md rename to docs/build-for-developers/state.md diff --git a/docs/developers/understanding.md b/docs/build-for-developers/understanding.md similarity index 100% rename from docs/developers/understanding.md rename to docs/build-for-developers/understanding.md diff --git a/docs/developers/working-with-branches.md b/docs/build-for-developers/working-with-branches.md similarity index 100% rename from docs/developers/working-with-branches.md rename to docs/build-for-developers/working-with-branches.md diff --git a/docs/intro/home.md b/docs/get-started/home.md similarity index 100% rename from docs/intro/home.md rename to docs/get-started/home.md diff --git a/docs/intro/implementation-checklist.md b/docs/get-started/implementation-checklist.md similarity index 100% rename from docs/intro/implementation-checklist.md rename to docs/get-started/implementation-checklist.md diff --git a/docs/intro/security-compliance.md b/docs/get-started/security-compliance.md similarity index 100% rename from docs/intro/security-compliance.md rename to docs/get-started/security-compliance.md diff --git a/docs/intro/security.md b/docs/get-started/security.md similarity index 100% rename from docs/intro/security.md rename to docs/get-started/security.md diff --git a/docs/intro/standards.md b/docs/get-started/standards.md similarity index 100% rename from docs/intro/standards.md rename to docs/get-started/standards.md diff --git a/docs/intro/terminology.md b/docs/get-started/terminology.md similarity index 100% rename from docs/intro/terminology.md rename to docs/get-started/terminology.md From 81aad124999898abb09da73f50d160c6a41f7505 Mon Sep 17 00:00:00 2001 From: aleksa-krolls Date: Wed, 29 Nov 2023 19:46:02 +0200 Subject: [PATCH 03/11] rename other sections --- docs/{support => get-help}/support.md | 0 docs/{projects => manage-projects}/platform-mgmt.md | 0 .../troubleshooting-tips-on-platform.md | 0 docs/{history => monitor-history}/activity-history.md | 0 docs/{users => users-credentials}/user-profile.md | 0 5 files changed, 0 insertions(+), 0 deletions(-) rename docs/{support => get-help}/support.md (100%) rename docs/{projects => manage-projects}/platform-mgmt.md (100%) rename docs/{projects => manage-projects}/troubleshooting-tips-on-platform.md (100%) rename docs/{history => monitor-history}/activity-history.md (100%) rename docs/{users => users-credentials}/user-profile.md (100%) diff --git a/docs/support/support.md b/docs/get-help/support.md similarity index 100% rename from docs/support/support.md rename to docs/get-help/support.md diff --git a/docs/projects/platform-mgmt.md b/docs/manage-projects/platform-mgmt.md similarity index 100% rename from docs/projects/platform-mgmt.md rename to docs/manage-projects/platform-mgmt.md diff --git a/docs/projects/troubleshooting-tips-on-platform.md b/docs/manage-projects/troubleshooting-tips-on-platform.md similarity index 100% rename from docs/projects/troubleshooting-tips-on-platform.md rename to docs/manage-projects/troubleshooting-tips-on-platform.md diff --git a/docs/history/activity-history.md b/docs/monitor-history/activity-history.md similarity index 100% rename from docs/history/activity-history.md rename to docs/monitor-history/activity-history.md diff --git a/docs/users/user-profile.md b/docs/users-credentials/user-profile.md similarity index 100% rename from docs/users/user-profile.md rename to docs/users-credentials/user-profile.md From 66ff6b166488dede46c36ec48654c7d80bcb220e Mon Sep 17 00:00:00 2001 From: aleksa-krolls Date: Wed, 29 Nov 2023 19:53:38 +0200 Subject: [PATCH 04/11] breaking out cli pages --- .../{for-devs.md => build-compliant-apps.md} | 0 docs/build-for-developers/cli-intro.md | 49 ++++++ .../{cli.md => cli-tutorial.md} | 140 +----------------- docs/build-for-developers/cli-usage.md | 98 ++++++++++++ 4 files changed, 151 insertions(+), 136 deletions(-) rename docs/build-for-developers/{for-devs.md => build-compliant-apps.md} (100%) create mode 100644 docs/build-for-developers/cli-intro.md rename docs/build-for-developers/{cli.md => cli-tutorial.md} (85%) create mode 100644 docs/build-for-developers/cli-usage.md diff --git a/docs/build-for-developers/for-devs.md b/docs/build-for-developers/build-compliant-apps.md similarity index 100% rename from docs/build-for-developers/for-devs.md rename to docs/build-for-developers/build-compliant-apps.md diff --git a/docs/build-for-developers/cli-intro.md b/docs/build-for-developers/cli-intro.md new file mode 100644 index 00000000000..c4ff1120aaa --- /dev/null +++ b/docs/build-for-developers/cli-intro.md @@ -0,0 +1,49 @@ +--- +title: Intro to the OpenFn CLI +sidebar_label: Intro to CLI +slug: /cli +--- + +:::info What is this tutorial? + +- It's a _hands-on_ way to learn about the new OpenFn CLI. By following the + prompts and "challenges", a developer with a bit of Javascript experience + should be able to write, run, and debug complex, multi-step jobs with OpenFn, + using nothing but a text editor and their terminal. +- The estimated time to finish this developer challenge is 1 to 2 hours + (depending on your familiarity with the underlying concepts and tooling) +- If you are stuck and need help, please post in + [community.openfn.org](https://community.openfn.org/t/about-the-job-writing-category/11/1) + +::: + +## Intro to the OpenFn CLI + +The [@openfn/cli](https://github.com/OpenFn/kit/tree/main/packages/cli) is a +command line interface for running OpenFn workflows locally. It enables +developers to run, build, and test steps in an OpenFn workflow. + +This CLI replaces [@openfn/devtools](https://github.com/OpenFn/devtools) and +provides a new suite of features and improvements, including: + +- a new runtime and compiler for executing and creating runnable OpenFn jobs, +- customizable logging output, +- automatic installation of language adaptors, +- and support for the adaptors monorepo + ([@openfn/adaptors](https://github.com/OpenFn/adaptors)) where all OpenFn + adaptor source code and documentation lives. + +These features are designed to make it easier and more convenient for developers +to use and understand OpenFn. + +:::caution Looking for a way to execute jobs from OpenFn v1 locally? Use Core! + +If you're looking for a way to execute jobs running on the OpenFn v1 platform, +please see the documentation for **[@openfn/core](/documentation/core)** and +[Devtools](/documentation/devtools/home). + +::: + + +Learn more about CLI +[github.com/OpenFn/kit/](https://github.com/OpenFn/kit/tree/main/packages/cli) diff --git a/docs/build-for-developers/cli.md b/docs/build-for-developers/cli-tutorial.md similarity index 85% rename from docs/build-for-developers/cli.md rename to docs/build-for-developers/cli-tutorial.md index db0a951c8e6..58e925fe8e6 100644 --- a/docs/build-for-developers/cli.md +++ b/docs/build-for-developers/cli-tutorial.md @@ -1,69 +1,9 @@ --- -title: The CLI -sidebar_label: CLI -slug: /cli +title: CLI Walkthrough & Challenges +sidebar_label: CLI Tutorial +slug: /cli-tutorial --- -:::info What is this tutorial? - -- It's a _hands-on_ way to learn about the new OpenFn CLI. By following the - prompts and "challenges", a developer with a bit of Javascript experience - should be able to write, run, and debug complex, multi-step jobs with OpenFn, - using nothing but a text editor and their terminal. -- The estimated time to finish this developer challenge is 1 to 2 hours - (depending on your familiarity with the underlying concepts and tooling) -- If you are stuck and need help, please post in - [community.openfn.org](https://community.openfn.org/t/about-the-job-writing-category/11/1) - -::: - -## Intro to the OpenFn CLI - -The [@openfn/cli](https://github.com/OpenFn/kit/tree/main/packages/cli) is a -command line interface for running OpenFn workflows locally. It enables -developers to run, build, and test steps in an OpenFn workflow. - -This CLI replaces [@openfn/devtools](https://github.com/OpenFn/devtools) and -provides a new suite of features and improvements, including: - -- a new runtime and compiler for executing and creating runnable OpenFn jobs, -- customizable logging output, -- automatic installation of language adaptors, -- and support for the adaptors monorepo - ([@openfn/adaptors](https://github.com/OpenFn/adaptors)) where all OpenFn - adaptor source code and documentation lives. - -These features are designed to make it easier and more convenient for developers -to use and understand OpenFn. - -:::caution Looking for a way to execute jobs from OpenFn v1 locally? Use Core! - -If you're looking for a way to execute jobs running on the OpenFn v1 platform, -please see the documentation for **[@openfn/core](/documentation/core)** and -[Devtools](/documentation/devtools/home). - -::: - -## Prerequisites - -1. Ensure you have a code editor installed on your machine (e.g. - [VS Code](https://code.visualstudio.com/), - [Sublime](https://www.sublimetext.com/)) - -2. Install NodeJs **v18 is the minimum version required** - - - To install a specific version of Node.js (in this case, version 18) on - Linux, Windows, or macOS, you can use a version manager such as nvm (Node - Version Manager) or any multiple runtime version manager eg: - [asdf](https://github.com/asdf-vm/asdf). These tools allow you to install - and switch between multiple versions of Node.js on the same machine. See - below for instructions for different operating systems. - - Read this article to learn how to install NodeJs in your machine - [kinsta.com/blog/how-to-install-node-js/](https://kinsta.com/blog/how-to-install-node-js/) - -3. Have a basic understanding of OpenFn—check out jobs and adaptors, at least, - in the [Intro section](documentation/next) of this site. -4. Install the OpenFn CLI with `npm install -g @openfn/cli` ## Walkthrough & Challenges @@ -1107,76 +1047,4 @@ outlined below: } ``` -::: - -## CLI Usage - Key Commands - -You’ll learn about these commands in the following challenges, but please refer -to this section for the key commands used in working with the CLI. - -### Check the version - -```bash -openfn version -``` - -### Get help - -```bash -openfn help -``` - -### Run a job - -```bash -openfn path/to/job.js -ia {adaptor-name} -``` - -Note: You MUST specify which adaptor to use. Pass the `-i` flag to auto-install -that adaptor (it's safe to do this redundantly). - -You can find the list of publicly available adaptors [here](/adaptors). - -> Path is the job to load the job from (a .js file or a dir containing a job.js -> file) For example `openfn execute hello.js ` Reads hello.js, looks for state -> and output in foo - -```bash --i, --autoinstall Auto-install the language adaptor --a, --adaptors, --adaptor A language adaptor to use for the job -``` - -If an adaptor is already installed by auto install, you can use the command -without the `-i` options. i.e `openfn hello.js -a http` - -### Change log level - -You can pass `-l info` or `--log info` to get more feedback about what's -happening, or `--log debug` for more details than you could ever use. Below is -the list of different log levels - -```bash -openfn hello.js -a http -l none -``` - -| log level | description | -| ------------ | -------------------------------------------------------- | -| `-l none` | Quiet mode | -| `-l default` | Top level information of what is happening | -| `-l info` | Get more feedback on what is happening openfn | -| `-l debug` | Get information about runtime, cli, compiler and the job | - -### Compilation - -The CLI will attempt to compile your job code into normalized Javascript. It -will do a number of things to make your code robust, portable, and easier to -debug from a pure JS perspective. - -```bash -openfn compile [path] -``` - -Will compile the openfn job and print or save the resulting js. - -Learn more about CLI -[github.com/OpenFn/kit/](https://github.com/OpenFn/kit/tree/main/packages/cli) +::: \ No newline at end of file diff --git a/docs/build-for-developers/cli-usage.md b/docs/build-for-developers/cli-usage.md new file mode 100644 index 00000000000..d30acf8986e --- /dev/null +++ b/docs/build-for-developers/cli-usage.md @@ -0,0 +1,98 @@ +--- +title: The CLI +sidebar_label: CLI +slug: /cli +--- + +## Prerequisites + +1. Ensure you have a code editor installed on your machine (e.g. + [VS Code](https://code.visualstudio.com/), + [Sublime](https://www.sublimetext.com/)) + +2. Install NodeJs **v18 is the minimum version required** + + - To install a specific version of Node.js (in this case, version 18) on + Linux, Windows, or macOS, you can use a version manager such as nvm (Node + Version Manager) or any multiple runtime version manager eg: + [asdf](https://github.com/asdf-vm/asdf). These tools allow you to install + and switch between multiple versions of Node.js on the same machine. See + below for instructions for different operating systems. + - Read this article to learn how to install NodeJs in your machine + [kinsta.com/blog/how-to-install-node-js/](https://kinsta.com/blog/how-to-install-node-js/) + +3. Have a basic understanding of OpenFn—check out jobs and adaptors, at least, + in the [Intro section](documentation/next) of this site. +4. Install the OpenFn CLI with `npm install -g @openfn/cli` + +## CLI Usage - Key Commands + +You’ll learn about these commands in the following challenges, but please refer +to this section for the key commands used in working with the CLI. + +### Check the version + +```bash +openfn version +``` + +### Get help + +```bash +openfn help +``` + +### Run a job + +```bash +openfn path/to/job.js -ia {adaptor-name} +``` + +Note: You MUST specify which adaptor to use. Pass the `-i` flag to auto-install +that adaptor (it's safe to do this redundantly). + +You can find the list of publicly available adaptors [here](/adaptors). + +> Path is the job to load the job from (a .js file or a dir containing a job.js +> file) For example `openfn execute hello.js ` Reads hello.js, looks for state +> and output in foo + +```bash +-i, --autoinstall Auto-install the language adaptor +-a, --adaptors, --adaptor A language adaptor to use for the job +``` + +If an adaptor is already installed by auto install, you can use the command +without the `-i` options. i.e `openfn hello.js -a http` + +### Change log level + +You can pass `-l info` or `--log info` to get more feedback about what's +happening, or `--log debug` for more details than you could ever use. Below is +the list of different log levels + +```bash +openfn hello.js -a http -l none +``` + +| log level | description | +| ------------ | -------------------------------------------------------- | +| `-l none` | Quiet mode | +| `-l default` | Top level information of what is happening | +| `-l info` | Get more feedback on what is happening openfn | +| `-l debug` | Get information about runtime, cli, compiler and the job | + +### Compilation + +The CLI will attempt to compile your job code into normalized Javascript. It +will do a number of things to make your code robust, portable, and easier to +debug from a pure JS perspective. + +```bash +openfn compile [path] +``` + +Will compile the openfn job and print or save the resulting js. + +Learn more about CLI +[github.com/OpenFn/kit/](https://github.com/OpenFn/kit/tree/main/packages/cli) From 7cf792bbbf0685850228fac7413d7df35058b05d Mon Sep 17 00:00:00 2001 From: aleksa-krolls Date: Wed, 29 Nov 2023 20:08:28 +0200 Subject: [PATCH 05/11] new docs pages for developers section --- docs/build-for-developers/build-with-api.md | 7 +++--- docs/build-for-developers/cli-usage.md | 2 +- .../build-for-developers/security-for-devs.md | 15 +++++++++++++ sidebars-main.js | 22 ++++++++++--------- 4 files changed, 32 insertions(+), 14 deletions(-) create mode 100644 docs/build-for-developers/security-for-devs.md diff --git a/docs/build-for-developers/build-with-api.md b/docs/build-for-developers/build-with-api.md index 20743d4224b..4e3a7d17a1c 100644 --- a/docs/build-for-developers/build-with-api.md +++ b/docs/build-for-developers/build-with-api.md @@ -1,7 +1,8 @@ --- id: build-with-api -title: Build with the OpenFn API -sidebar_label: OpenFn API +title: Build Projects via the OpenFn API +sidebar_label: Build with API slug: /build-with-api --- -Build with API (link to Github) / Build an Adaptor \ No newline at end of file + +OpenFn offers the ability to configure projects via HTTP requests sent to the REST API. See the [OpenFn/Lightning Github repo](https://openfn.github.io/Lightning/provisioning.html) for detailed developer documentation. diff --git a/docs/build-for-developers/cli-usage.md b/docs/build-for-developers/cli-usage.md index d30acf8986e..19d18e7de77 100644 --- a/docs/build-for-developers/cli-usage.md +++ b/docs/build-for-developers/cli-usage.md @@ -1,7 +1,7 @@ --- title: The CLI sidebar_label: CLI -slug: /cli +slug: /cli-usage --- ## Prerequisites diff --git a/docs/build-for-developers/security-for-devs.md b/docs/build-for-developers/security-for-devs.md new file mode 100644 index 00000000000..426f2e709cc --- /dev/null +++ b/docs/build-for-developers/security-for-devs.md @@ -0,0 +1,15 @@ +--- +id: security-for-devs +title: Security Considerations for Development +sidebar_label: Security Considerations +slug: /security-for-devs +--- + +:::warning Under construction + +This docs page is under construction. Check back later for the complete docs, or check out the Docs Version "Platform (v1)". + +::: + + + diff --git a/sidebars-main.js b/sidebars-main.js index b5c95173e1a..572f5c70603 100644 --- a/sidebars-main.js +++ b/sidebars-main.js @@ -2,7 +2,7 @@ module.exports = { docs: [ { type: 'category', - label: 'Intro', + label: 'Get Started', items: [ 'intro/home', // 'intro/terminology', @@ -14,7 +14,7 @@ module.exports = { }, { type: 'category', - label: 'Designing Workflows', + label: 'Design Workflows', items: [ 'design/overview', //'design/discovery' @@ -27,7 +27,7 @@ module.exports = { }, { type: 'category', - label: 'Build Workflows', + label: 'Build & Manage Workflows', items: [ 'build/tutorial', 'developers/limits', @@ -36,21 +36,23 @@ module.exports = { }, { type: 'category', - label: 'Developers', + label: 'Build Workflows (For Developers)', items: [ 'developers/cli', + 'developers/cli-usage', + 'developers/cli-tutorial', + 'developers/build-with-api', //'developers/for-devs' ], }, { type: 'category', - label: 'Local Deployment', + label: 'Deploy', items: ['deploy/options', 'deploy/requirements', 'deploy/portability'], }, - { type: 'category', - label: 'Monitor Activity History', + label: 'Monitor History', items: ['history/activity-history'], }, { @@ -60,17 +62,17 @@ module.exports = { }, { type: 'category', - label: 'User Management', + label: 'Manage Users & Credentials', items: ['users/user-profile'], }, { type: 'category', - label: 'Support', + label: 'Get Help', items: ['support/support'], }, { type: 'category', - label: 'Docs & Roadmap', + label: 'Contribute - Docs & Roadmap', items: [ 'contributing/openfn-roadmap', // 'contributing/roadmap', From fbed75b36b54eb7a7a64bfcdc2ffbd6f23d9495b Mon Sep 17 00:00:00 2001 From: aleksa-krolls Date: Wed, 29 Nov 2023 20:15:07 +0200 Subject: [PATCH 06/11] sidebar pages viewed update --- sidebars-main.js | 1 + 1 file changed, 1 insertion(+) diff --git a/sidebars-main.js b/sidebars-main.js index 572f5c70603..77cea085986 100644 --- a/sidebars-main.js +++ b/sidebars-main.js @@ -42,6 +42,7 @@ module.exports = { 'developers/cli-usage', 'developers/cli-tutorial', 'developers/build-with-api', + 'developers/security-for-devs', //'developers/for-devs' ], }, From 2222e9461f16b7ad78583d8f66a9114d1fde14d6 Mon Sep 17 00:00:00 2001 From: aleksa-krolls Date: Wed, 29 Nov 2023 20:19:11 +0200 Subject: [PATCH 07/11] update sidebar directory referenced, move limits file --- .../{build-for-developers => build}/limits.md | 0 sidebars-main.js | 34 +++++++++---------- 2 files changed, 17 insertions(+), 17 deletions(-) rename docs/{build-for-developers => build}/limits.md (100%) diff --git a/docs/build-for-developers/limits.md b/docs/build/limits.md similarity index 100% rename from docs/build-for-developers/limits.md rename to docs/build/limits.md diff --git a/sidebars-main.js b/sidebars-main.js index 77cea085986..9d47d3cf8cf 100644 --- a/sidebars-main.js +++ b/sidebars-main.js @@ -4,7 +4,7 @@ module.exports = { type: 'category', label: 'Get Started', items: [ - 'intro/home', + 'get-started/home', // 'intro/terminology', // 'intro/standards', // 'intro/security-compliance', @@ -30,7 +30,7 @@ module.exports = { label: 'Build & Manage Workflows', items: [ 'build/tutorial', - 'developers/limits', + 'build/limits', // 'build/triggers' ], }, @@ -38,12 +38,12 @@ module.exports = { type: 'category', label: 'Build Workflows (For Developers)', items: [ - 'developers/cli', - 'developers/cli-usage', - 'developers/cli-tutorial', - 'developers/build-with-api', - 'developers/security-for-devs', - //'developers/for-devs' + 'build-for-developers/cli', + 'build-for-developers/cli-usage', + 'build-for-developers/cli-tutorial', + 'build-for-developers/build-with-api', + 'build-for-developers/security-for-devs', + //'build-for-developers/for-devs' ], }, { @@ -54,32 +54,32 @@ module.exports = { { type: 'category', label: 'Monitor History', - items: ['history/activity-history'], + items: ['monitor-history/activity-history'], }, { type: 'category', label: 'Manage Projects', - items: ['projects/platform-mgmt'], + items: ['manage-projects/platform-mgmt'], }, { type: 'category', label: 'Manage Users & Credentials', - items: ['users/user-profile'], + items: ['users-credentials/user-profile'], }, { type: 'category', label: 'Get Help', - items: ['support/support'], + items: ['get-help/support'], }, { type: 'category', label: 'Contribute - Docs & Roadmap', items: [ - 'contributing/openfn-roadmap', - // 'contributing/roadmap', - // 'contributing/writing-code', - // 'contributing/writing-docs', - // 'contributing/style-guide', + 'contribute/openfn-roadmap', + // 'contribute/roadmap', + // 'contribute/writing-code', + 'contribute/writing-docs', + 'contribute/style-guide', ], }, { From d041917713d721b272d9f767e903330d79b7907b Mon Sep 17 00:00:00 2001 From: aleksa-krolls Date: Wed, 29 Nov 2023 20:29:23 +0200 Subject: [PATCH 08/11] user section & sidebar update --- docs/{users-credentials => manage-users}/user-profile.md | 0 sidebars-main.js | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/{users-credentials => manage-users}/user-profile.md (100%) diff --git a/docs/users-credentials/user-profile.md b/docs/manage-users/user-profile.md similarity index 100% rename from docs/users-credentials/user-profile.md rename to docs/manage-users/user-profile.md diff --git a/sidebars-main.js b/sidebars-main.js index 9d47d3cf8cf..c675d9f14ff 100644 --- a/sidebars-main.js +++ b/sidebars-main.js @@ -64,7 +64,7 @@ module.exports = { { type: 'category', label: 'Manage Users & Credentials', - items: ['users-credentials/user-profile'], + items: ['manage-users/user-profile'], }, { type: 'category', From b06b26239e304599e986f41e1339465dbc019615 Mon Sep 17 00:00:00 2001 From: aleksa-krolls Date: Wed, 29 Nov 2023 20:38:46 +0200 Subject: [PATCH 09/11] section renaming, sidebar update --- docs/manage-users/user-profile.md | 1 + docs/tutorials/kobo-to-dhis2.md | 1 + sidebars-main.js | 10 +++++----- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/manage-users/user-profile.md b/docs/manage-users/user-profile.md index a404372ef7c..b7d2b5f8655 100644 --- a/docs/manage-users/user-profile.md +++ b/docs/manage-users/user-profile.md @@ -1,6 +1,7 @@ --- title: Update User Profile sidebar_label: User Profile +slug: /user-profile --- :::warning Under construction diff --git a/docs/tutorials/kobo-to-dhis2.md b/docs/tutorials/kobo-to-dhis2.md index 695f2b29942..e0815c0c4a7 100644 --- a/docs/tutorials/kobo-to-dhis2.md +++ b/docs/tutorials/kobo-to-dhis2.md @@ -1,6 +1,7 @@ --- sidebar_label: Kobo to DHIS2 title: Kobo to DHIS2 Reporting Workflow +slug: /kobo-to-dhis2 --- :::warning Under construction diff --git a/sidebars-main.js b/sidebars-main.js index c675d9f14ff..942667eb01f 100644 --- a/sidebars-main.js +++ b/sidebars-main.js @@ -20,11 +20,11 @@ module.exports = { //'design/discovery' ], }, - { - type: 'category', - label: 'Tutorials', - items: ['tutorials/kobo-to-dhis2'], - }, + // { + // type: 'category', + // label: 'Tutorials', + // items: ['tutorials/kobo-to-dhis2'], + // }, { type: 'category', label: 'Build & Manage Workflows', From 3e66c0f5d9867600aa02c5aad14a2dd7afd887df Mon Sep 17 00:00:00 2001 From: aleksa-krolls Date: Wed, 29 Nov 2023 20:39:54 +0200 Subject: [PATCH 10/11] cli sidebar reference update --- sidebars-main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sidebars-main.js b/sidebars-main.js index 942667eb01f..b3fdc2c6fe4 100644 --- a/sidebars-main.js +++ b/sidebars-main.js @@ -38,7 +38,7 @@ module.exports = { type: 'category', label: 'Build Workflows (For Developers)', items: [ - 'build-for-developers/cli', + 'build-for-developers/cli-intro', 'build-for-developers/cli-usage', 'build-for-developers/cli-tutorial', 'build-for-developers/build-with-api', From b3125c692b0fca01aa9013fc640766287ca2ea04 Mon Sep 17 00:00:00 2001 From: aleksa-krolls Date: Wed, 29 Nov 2023 20:48:38 +0200 Subject: [PATCH 11/11] renaming titles --- docs/build-for-developers/build-with-api.md | 2 +- docs/build-for-developers/cli-usage.md | 4 ++-- sidebars-main.js | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/build-for-developers/build-with-api.md b/docs/build-for-developers/build-with-api.md index 4e3a7d17a1c..8ce51de9da5 100644 --- a/docs/build-for-developers/build-with-api.md +++ b/docs/build-for-developers/build-with-api.md @@ -1,7 +1,7 @@ --- id: build-with-api title: Build Projects via the OpenFn API -sidebar_label: Build with API +sidebar_label: Build with the API slug: /build-with-api --- diff --git a/docs/build-for-developers/cli-usage.md b/docs/build-for-developers/cli-usage.md index 19d18e7de77..a6255cca25a 100644 --- a/docs/build-for-developers/cli-usage.md +++ b/docs/build-for-developers/cli-usage.md @@ -1,6 +1,6 @@ --- -title: The CLI -sidebar_label: CLI +title: Using the CLI +sidebar_label: CLI Usage slug: /cli-usage --- diff --git a/sidebars-main.js b/sidebars-main.js index b3fdc2c6fe4..c31cdabb374 100644 --- a/sidebars-main.js +++ b/sidebars-main.js @@ -36,7 +36,7 @@ module.exports = { }, { type: 'category', - label: 'Build Workflows (For Developers)', + label: 'Build (For Developers)', items: [ 'build-for-developers/cli-intro', 'build-for-developers/cli-usage',