build-trust/ockam-documentation

Markdown files that are used to generate docs.ockam.io

ockam-documentation's Issues

How to update the command manual

# After command has release v0.85.0 

# Clone the documentation repo
git clone [email protected]:build-trust/ockam-documentation.git
cd ockam-documentation

# Checkout the command branch.
# Note that the `main` branch has the gitbook site and `command` branch has teh manual
# These are compeletely diverged branches with no shared history
git checkout command

### DELETE everything in manual directory except manual/template

# Change to the mdbook template directory
cd manual/template/mdbook

# Run the build script, this will ovewrite directories in the directory tree.
./build.sh v0.85.0

# Create a Pull Request against the command branch.

# When this PR is merged https://command.ockam.io/manual/ and chttps://command.ockam.io/manual/v0.85.0/
# will show docs for version v0.85.0

Rename `ockam project enroll` command to `ockam project ticket`

Update examples of ockam project enroll to ockam project ticket

Related to build-trust/ockam#4939

100% bats test coverage for ockam CLI documentation

Have bats tests written for all ockam documentation CLI examples

Improve the documentation for Okta example

Article that needs to be updated: https://docs.ockam.io/guides/examples/okta

--

In the code example in Engineer in San Francisco, replace:

• ockam project import project.json with:
• ockam project import --project-file project.json

--

Replace the 1st paragraph in Required Dependencies:

Through this example https://trial-9434859.okta.com/oauth2/default refers to an existing Okta endpoint where workforce identities are defined. Please create a trial account for Okta, if you don't have an account already. You can get your Okta URL and Client ID information from okta.com.

If you create a trial account, make sure to create a new app integration for this example. Then choose "OIDC - OpenID connect" for the Sign-in method and "Native Application" for the Application type, in Okta's website.

--

To make it clearer that the okta.com URLs and Client IDs are placeholders, perhaps use all caps variable names in the code example below, in Administrator section:

• replace https://trial-9434859.okta.com/oauth2/default with YOUR_OKTA_OAUTH2_URL
• and 0oa2pi8no6Kb04frP697 with YOUR_CLIENT_ID

Rename `ockam project authenticate` command to `ockam project enroll`

Update examples of ockam project authenticate to ockam project enroll

Related to build-trust/ockam#4940

Use case refactor (simplify & extract to code ex): ABAC (for Glenn)

Epic: weekly blog post & docs.ockam.io content updates

• Refactor this: https://docs.ockam.io/guides/use-cases/use-employee-attributes-from-okta-to-build-trust-with-cryptographically-verifiable-credentials
• Into this: https://docs.ockam.io/guides/examples/okta

Use case refactor (simplify & extract to code ex): Okta (for Glenn)

Epic: weekly blog post & docs.ockam.io content updates

Refactor this: https://docs.ockam.io/guides/use-cases/apply-fine-grained-permissions-with-attribute-based-access-control-abac
Into this: https://docs.ockam.io/guides/examples/abac