Skip to content

Conversation

@sg-doc-holiday
Copy link
Contributor

@sg-doc-holiday sg-doc-holiday bot commented Jan 14, 2026

Documentation corrections

  • Adds a new section to analytics.mdx documenting the SHOW_DEMO_HOME_PAGE flag that controls demo dashboard seeding in the analytics portal
  • Normalizes curly apostrophes to straight apostrophes throughout the analytics.mdx file to comply with style guidelines
  • Enhances the analytics.mdx documentation with detailed instructions and images for creating charts, connecting external data sources, and accessing the analytics admin portal
  • Adds a short constraints section to tables.mdx explaining that the OpenOps Tables admin setup assumes a single workspace, database, and database token, and describes errors thrown if these conditions are not met to help users troubleshoot setup failures
  • Restores the missing 'Creating new tables' section heading in tables.mdx to maintain the document's original structure after adding the constraints section
  • Further normalizes apostrophes in analytics.mdx instructions to conform fully to style guide requirements
  • Adds detailed troubleshooting information in tables.mdx describing error conditions caused by multiple workspaces, databases, or tokens in the OpenOps Tables setup
  • Restores the 'Creating new tables' section heading in tables.mdx to preserve original document structure after inserting the constraints section
  • Adds documentation clarifying that running OpenOps without Analytics is supported and that Analytics seeding is skipped if OPS_ANALYTICS_PRIVATE_URL is not configured
  • Makes minor stylistic corrections by converting remaining curly apostrophes to straight apostrophes in analytics.mdx to maintain consistent formatting

This covers 4 commits.

Interaction Instructions

This PR was generated by Doc Holiday and is ready to be iterated on.

Leave comments on this pull request in plain English to guide Doc Holiday's next steps.
You might ask to:

  • Update or rewrite documentation
  • Create or update release notes
  • Remove sections or files
  • Merge this PR with another Doc Holiday PR

Examples:

  • @doc.holiday update these docs to follow my style guide: https://link.to/style-guide
  • @doc.holiday write new documentation about quantum compute and how its steam generates a 429
  • @doc.holiday combine this PR with #404
  • @doc.holiday delete this file: release-notes/file.md

This was opened from: https://github.com/openops-cloud/openops/releases/tag/untagged-2017bc6209c4379b909f

Insert a new section documenting SHOW_DEMO_HOME_PAGE-controlled demo dashboard seeding (Homepage) as implemented in analytics-seeding-service.ts, and normalize curly apostrophes to straight apostrophes per style guide.
Add a short constraints section grounded in default-workspace-database.ts: OpenOps Tables admin setup assumes a single workspace, single database, and single database token; otherwise the server throws. This helps users troubleshoot unexpected startup/setup failures related to Tables.
Restore the missing 'Creating new tables' section heading so the page keeps its original structure after inserting the new constraints section.
Normalize curly apostrophe to straight apostrophe in analytics instructions to follow the style guide formatting requirements.
Insert a concise section documenting that Analytics is optional, based on server seeding logic that skips when OPS_ANALYTICS_PRIVATE_URL is not configured.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant