Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate surveilr-specific content from docs.opsfolio.com to surveilr.com/docs #6

Open
11 of 21 tasks
shah opened this issue Sep 25, 2024 · 3 comments
Open
11 of 21 tasks
Assignees

Comments

@shah
Copy link
Contributor

shah commented Sep 25, 2024

We should have these top-level sections -- Core and Pro might be sold separately in the future, for now both are in the same binary but we can start think about it conceptually that surveilr Pro is the "advanced" product with udi-pgp and maybe DuckDB, Rhai and others later?

  • Overview and Concepts (NOTE: this is where to introduce what is core vs. pro, the Std Library, what is an RSSD, etc.).
  • surveilr Core
    • Installation and Usage
    • surveilr CLI
      • Ingest Commands
      • (...other commands)
      • Shell and Orchestration Commands
    • Capturable Executables
  • surveilr Pro
    • UDI PostgreSQL Proxy Commands
  • Standard Library
    • RSSD Schema
    • Notebooks Schema
    • Console Web UI
  • Patterns
    • Universal Patterns
    • Industry-specific Patterns
    • Discipline-centric Patterns
  • Services
    • Diabetes Research Hub Edge
  • Cookbook and Snippets (NOTE: this will be coming soon)

Please ensure that SQLite3 is not used in the documentation; use surveilr shell instead.

@pradeepcdlm
Copy link
Contributor

@temiye18
As discussed on 09/25/2024, we need to reorganize the menu structure and content to align with the order and pattern outlined in the ticket description. Please proceed with rearranging the menu/content accordingly.

cc @geovlazar

RejinaKP added a commit that referenced this issue Sep 26, 2024
@pradeepcdlm
Copy link
Contributor

pradeepcdlm commented Sep 27, 2024

@temiye18 reminder to ensure that sqlite3 is not used in the documentation; use surveilr shell instead.

@pradeepcdlm
Copy link
Contributor

@temiye18 , @geovlazar Please update the ticket by marking a check next to the parts you have completed.
cc @RejinaKP

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

No branches or pull requests

4 participants