From 7cf792bbbf0685850228fac7413d7df35058b05d Mon Sep 17 00:00:00 2001 From: aleksa-krolls Date: Wed, 29 Nov 2023 20:08:28 +0200 Subject: [PATCH] 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',