Skip to content

docs: add example database queries to the Proxy getting started#176

Merged
auxesis merged 12 commits intomainfrom
add-example-statements-to-docs
Mar 19, 2025
Merged

docs: add example database queries to the Proxy getting started#176
auxesis merged 12 commits intomainfrom
add-example-statements-to-docs

Conversation

@tobyhede
Copy link
Contributor

@tobyhede tobyhede commented Mar 18, 2025

Easiest way to review the documentation changes is here: https://github.com/cipherstash/proxy/tree/add-example-statements-to-docs?tab=readme-ov-file#getting-started

Summary of the changes:

  • Add example schema for getting started
  • Install the example schema during Proxy container boot if asked
  • Output success on schema application, EQL installation, and container setup
  • Add detailed steps and explanations for inserting and querying data

@tobyhede tobyhede force-pushed the add-example-statements-to-docs branch 2 times, most recently from 72ed00b to 973048f Compare March 19, 2025 00:33
@auxesis auxesis force-pushed the add-example-statements-to-docs branch from b086ce2 to 0e3d763 Compare March 19, 2025 01:17
@auxesis auxesis force-pushed the add-example-statements-to-docs branch from c5b2eb4 to 586d156 Compare March 19, 2025 01:35
@auxesis auxesis changed the title Add example database queries to the Proxy getting started docs: add example database queries to the Proxy getting started Mar 19, 2025
fix(README): punctuation
fix(README): Added note to explain example table

Signed-off-by: Kate Andrews <keandrews@gmail.com>
Copy link
Contributor

@kateandrews kateandrews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@auxesis auxesis merged commit bee65ab into main Mar 19, 2025
1 check passed
@auxesis auxesis deleted the add-example-statements-to-docs branch March 19, 2025 05:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants