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

feature request: Improve Documentation Structure: Consolidate Installation, Deployment, and Upgrade Guides #6805

Open
Loongphy opened this issue Nov 14, 2024 · 3 comments
Labels

Comments

@Loongphy
Copy link

What problem did you meet?

  • Installation, deployment, and upgrade guides are fragmented across different sections
  • No clear navigation path between related documentation
  • Heavy reliance on search functionality to find related content
  • Poor user experience when trying to find specific deployment-related information

Description

While attempting to upgrade Logto to a newer version, I encountered difficulties in locating comprehensive deployment and update documentation. The current documentation structure has installation, deployment, and upgrade guides scattered across different sections, making it challenging to find related information efficiently. Even with the search functionality, the experience was cumbersome and time-consuming.

Describe what you'd like Logto to have

Suggested Improvements

  1. Consolidate all deployment-related documentation under a single section
  2. Create a clear hierarchical structure:
    • Getting Started
      • Installation Guide
      • Deployment Options
      • Upgrade Process
      • Migration Guide
  3. Add cross-references between related sections
  4. Include a quick navigation sidebar for deployment-related topics

Example Reference

TimescaleDB's documentation provides a good reference for organized documentation structure, with clear separation and logical grouping of related topics.

https://docs.timescale.com/self-hosted/latest/install/
image

@Loongphy
Copy link
Author

I'd be happy to help, but I lack experience in document building.

Copy link
Contributor

We hear you, we have new docs planned for release by end of the year.

@linear linear bot added the content label Nov 14, 2024
@Loongphy
Copy link
Author

upgrade failed: error Found undeployed database alterations, you must deploy them first by npm run alteration deploy command.

  1. Before upgraded, install CLI in the current instance
npm install -g @logto/cli
  1. Run database migrations

link https://docs.logto.io/docs/references/using-cli/database-alteration/#determine-the-version-to-deploy

logto db alt deploy <your-version>
  1. Stop the current instance, start the desired version instance

ref: #6535 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

No branches or pull requests

2 participants