Skip to content

Commit

Permalink
new docs pages for developers section
Browse files Browse the repository at this point in the history
  • Loading branch information
aleksa-krolls committed Nov 29, 2023
1 parent 66ff6b1 commit 7cf792b
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 14 deletions.
7 changes: 4 additions & 3 deletions docs/build-for-developers/build-with-api.md
Original file line number Diff line number Diff line change
@@ -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

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.
2 changes: 1 addition & 1 deletion docs/build-for-developers/cli-usage.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: The CLI
sidebar_label: CLI
slug: /cli
slug: /cli-usage
---

## Prerequisites
Expand Down
15 changes: 15 additions & 0 deletions docs/build-for-developers/security-for-devs.md
Original file line number Diff line number Diff line change
@@ -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)".

:::

<!--TODO: Add content on how to use console.log() and other security considerations for developing jobs -->

22 changes: 12 additions & 10 deletions sidebars-main.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module.exports = {
docs: [
{
type: 'category',
label: 'Intro',
label: 'Get Started',
items: [
'intro/home',
// 'intro/terminology',
Expand All @@ -14,7 +14,7 @@ module.exports = {
},
{
type: 'category',
label: 'Designing Workflows',
label: 'Design Workflows',
items: [
'design/overview',
//'design/discovery'
Expand All @@ -27,7 +27,7 @@ module.exports = {
},
{
type: 'category',
label: 'Build Workflows',
label: 'Build & Manage Workflows',
items: [
'build/tutorial',
'developers/limits',
Expand All @@ -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'],
},
{
Expand All @@ -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',
Expand Down

0 comments on commit 7cf792b

Please sign in to comment.