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

feat: self-hosting sidebar restructuring #2669

Merged
merged 136 commits into from
Dec 31, 2024

Conversation

jnikhila
Copy link
Collaborator

@jnikhila jnikhila commented Nov 19, 2024

Description

Provide a concise summary of the changes made in this pull request

Restructuring of the Self-Hosting Sidebar

  • New Parent Category:
    • Self-Hosting added as a standalone parent category (moved out of Getting Started).
  • Subcategories under Self-Hosting:
    • New Installation Guides
    • Manage Installation
    • Upgrade Installation Guides
    • Concepts

Documentation Overhaul

  • Rewrote all documentation to align with:

    • Diataxis Framework for clear organization and user focus.
    • Google Developer Documentation Style Guide for consistency and readability.
    • Updated content for accuracy and usability.
  • Archived outdated migration guides by moving them to the community portal and implemented redirects to ensure users can still access them if needed.

  • Updated all cross-references to reflect the new structure.

  • Modified the card design across docs

User tests

  1. https://app.usertesting.com/workspaces/2411288/study/5397388/sessions

Pull request type

Check the appropriate box:

  • Review Fixes
  • Documentation Overhaul
  • Feature/Story
    • Link one or more Engineering Tickets
      *
  • A-Force
  • Error in documentation
  • Maintenance

Documentation tickets

Link to one or more documentation tickets:

Checklist

From the below options, select the ones that are applicable:

  • Checked for Grammarly suggestions.
  • Adhered to the writing checklist.
  • Adhered to the media checklist.
  • Verified and updated cross-references or added redirect rules.
  • Tested the redirect rules on deploy preview.
  • Validated the modifications made to the content on the deploy preview.
  • Validated the CSS modifications on different screen sizes.

Copy link

vercel bot commented Nov 19, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
appsmith-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 31, 2024 8:55am

@jnikhila jnikhila marked this pull request as ready for review December 31, 2024 04:37
@jnikhila jnikhila merged commit 479aec1 into main Dec 31, 2024
5 checks passed
@jnikhila jnikhila deleted the feat-self-hosting-sidebar-restructure branch December 31, 2024 12:58
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.

2 participants