Improve the Server Upgrade page (migration guides)
Open
Nobody has claimed this yet.
cloud/server
- Dominant language
- Vue
- Stars
- 15
- Forks
- 22
- Avg merge
- 5d 11h
- Merged PRs (30d)
- 9
Description
I have some suggestions for the https://merginmaps.com/docs/server/upgrade/ page to provide better overview for users:
- consistent use of and badges. I think that badges should be used directly under the header. Using badges in the text / under the info box should be avoided.
- in https://merginmaps.com/docs/server/upgrade/#migration-guide-from-2023-2-0-to-2023-6-1 and https://merginmaps.com/docs/server/upgrade/#migration-guide-from-2023-6-1-to-2024-2-x-ce, badges should be replaced by appropriate headings or there should be separate guides for CE and EE
- Migration guides could be group together based on CE / EE
- https://merginmaps.com/docs/server/upgrade/#migration-guide-from-2023-6-1-to-2024-2-x-ce is marked as CE, but it contains the migration guide for both CE and EE
This is good:
This is not so good:
This is bad:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the server upgrade page and inspect the migration guide headings and each MigrationType badge. The work is done when CE and EE guides are clearly grouped or separated, badges appear directly under the relevant headers, and the 2023-6-1 to 2024-2-x guide is labeled accurately.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100