Improve the Server Upgrade page (migration guides)
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
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.
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:
- Dominant language
- Vue
- Stars
- 15
- Forks
- 22
- Avg merge
- 5d 19h
- Merged PRs (30d)
- 11
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.
More from MerginMaps/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
MerginMaps/docs#757 ·
-
mobile app reference
Difficulty 1/5 1-3 hours Newbie friendliness 68/100
MerginMaps/docs#124 · 20 comments ·
-
not-released-yet
Difficulty 3/5 1-2 days Newbie friendliness 45/100
MerginMaps/docs#823 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
MerginMaps/docs#804 ·
-
not-released-yet
Difficulty 5/5 Over a week Newbie friendliness 20/100
MerginMaps/docs#801 ·
Similar issues
-
Area: Excel support
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
orbeon/orbeon-forms#7893 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
docToolchain/docToolchain#1705 ·
-
kb-infra-drift
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OCHA-DAP/ds-knowledge-base#653 · 1 comment ·
-
area/dev-productivity area/disaster-recovery area/ipcei kind/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
namespace operations
Difficulty 1/5 Under an hour Newbie friendliness 90/100
EclipseFdn/open-vsx.org#13419 ·