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.

Sign up for GitHub

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

Jump to bottom

[Docs]: Self-Hosting - Doc Update #2509

Open
docs-appsmith opened this issue Sep 10, 2024 · 0 comments
Open

[Docs]: Self-Hosting - Doc Update #2509

docs-appsmith opened this issue Sep 10, 2024 · 0 comments
Labels
Documentation Improvements or additions to documentation User Education Pod Issues related to user education

Comments

@docs-appsmith
Copy link
Collaborator

Problem Statement

Self-Hosting - Doc Update

Other Relevant URLs

Draft: https://www.notion.so/Self-Hosting-Doc-Update-20684deee10345bca20f7b395dc3cd4c
Slack/conversation:
@docs-appsmith docs-appsmith added Documentation Improvements or additions to documentation User Education Pod Issues related to user education labels Sep 10, 2024
@jnikhila jnikhila mentioned this issue Dec 26, 2024
Merged
13 tasks
jnikhila added a commit that referenced this issue Dec 31, 2024
@jnikhila
feat: self-hosting sidebar restructuring (#2669)
479aec1 
## 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
- [x] 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:
 - #2509 (Project)

## Checklist

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

- [x] Checked for Grammarly suggestions.
- [x] Adhered to the writing checklist.
- [x] Adhered to the media checklist.
- [x] Verified and updated cross-references or added redirect rules.
- [x] Tested the redirect rules on deploy preview.
- [x] Validated the modifications made to the content on the deploy
preview.
- [x] Validated the CSS modifications on different screen sizes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Improvements or additions to documentation User Education Pod Issues related to user education
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@docs-appsmith