structure changes #5
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…-flow-docs into flow-content-v1
…-flow-docs into flow-content-v1
…-flow-docs into flow-content-v1
…-flow-docs into flow-content-v1
docs/modules/ROOT/nav.adoc
Outdated
|
|
||
| .Deploy and Operate | ||
| * xref:deploying:development-deployments.adoc[Quickstart] | ||
| * xref:deploying:production-deployments.adoc[Production Deployment] |
There was a problem hiding this comment.
Production deployment
(note we use sentence case)
docs/modules/ROOT/nav.adoc
Outdated
|
|
||
| .Architecture | ||
| * {short-product-name} components | ||
| * Jet Jobs |
docs/modules/ROOT/nav.adoc
Outdated
| .Architecture | ||
| * {short-product-name} components | ||
| * Jet Jobs | ||
| * Roles and Permissions |
There was a problem hiding this comment.
Roles and permissions
| == Advanced Setup | ||
|
|
||
| * Enable xref:deploying:authentication.adoc[authentication] and xref:deploying:authorization.adoc[authorization] in {short-product-name} | ||
| * Use a xref:workspace:overview.adoc#reading-workspace-conf-from-git[Git-backed workspace.conf file], to align with IAC |
There was a problem hiding this comment.
should we explain what IAC is here?
|
|
||
| With examples for: | ||
|
|
||
| * Running with an external hazelcast cluster |
| * Use a xref:workspace:overview.adoc#reading-workspace-conf-from-git[Git-backed workspace.conf file], to align with IAC | ||
| * Understand how xref:deploying:managing-secrets.adoc[secrets are handled] in {short-product-name} | ||
| * Understand how to configure {short-product-name} via xref:deploying:configuring.adoc#docker[application properties] or xref:deploying:configuring.adoc#passing-{short-product-name}-application-configuration[environment variables] | ||
| Out recommended deployment method is with `docker compose` or deploying the docker container directly using the orchestrator of your choice. |
There was a problem hiding this comment.
Suggested change
| Out recommended deployment method is with `docker compose` or deploying the docker container directly using the orchestrator of your choice. | |
| Our recommended deployment method is with `docker compose` or deploying the Docker container directly using the orchestrator of your choice. |
|
|
||
| Author's note - there used to be a link to https://github.com/orbitalapi/deploy - what should it be now? | ||
| * Running with an external hazelcast cluster |
|
|
||
| Author's note - links in table are broken - please confirm what these should be: | ||
| == Further Deployment Templates |
There was a problem hiding this comment.
Further deployment templates
| @@ -0,0 +1,11 @@ | |||
| = Security Recommendations | |||
| :description Best practises for deploying into production | |||
amandalindsay
requested changes
Aug 13, 2024
|
Thanks @amandalindsay, much appreciated, should all be updated As for the 'flows' terminology I'll take that to Slack, I'll see if we need something/can come up with something, else will reword it |
pollett
force-pushed
the
flow-docs-structure
branch
2 times, most recently
from
cb00fa5
to
9d56446
Compare
pollett
force-pushed
the
flow-docs-structure
branch
from
9d56446
to
9c691e4
Compare
pollett
force-pushed
the
flow-docs-structure
branch
from
289fcf6
to
b80d38b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@amandalindsay not sure whether it's easier for us to merge these and tweak on them as we go, or whether you'd prefer one big one and we can figure any conflicts at the end - obviously feel free to comment on this on either the structure or my horrible wording!