Lectern documentation update #299
Open
+1,252
−290
Conversation
This file contains hidden or 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
3 tasks
joneubank
approved these changes
Jul 10, 2025
|
|
||
| 1. Set `AUTH_ENABLED=true` in your `.env` file | ||
| 2. Configure `EGO_API` to point to your Ego authorization service | ||
| 3. Set the appropriate `SCOPE` for your permissions |
There was a problem hiding this comment.
This is unclear, maybe we need to link to a reference that explains scopes from Ego/Keycloak. I wouldn't know what value to set in this.
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.
Pages in this update
Netlify Preview pages linked (requires VPN)
Content Not in this update
Note
Feel free to list any other missing/desired content here
Pre-existing content moved to
pendingDocsdirectoryThese are documentation items that are in a pending/incomplete state that should not be deleted but need to be placed somewhere outside of the docs folder.
Migration
Validation
Pending Content
Need updated links for the Source Code Reference section
Source code for the Lectern Dictionary meta-schema is made available through the package @overture-stack/lectern-dictionary. The meta-schema is formally defined in TypeScript and exported as the type
Dictionaryfrom the filedictionary/src/types/dictionaryTypes.ts. This definition is created using [Zod] schemas, which are also exported from this package and available for use to confirm a given object is a valid Lectern Dictionary.