Hacker News new | past | comments | ask | show | jobs | submit login

What is the topic in our documentation you think we should improve first?



Thoroughness? Accuracy? Here's an example. Someone attempting to upgrade their omnibus package installed instance will likely find the following resource:

https://docs.gitlab.com/omnibus/update/

This page links to the following "upgrade recommendations" resource:

https://docs.gitlab.com/ee/policy/maintenance.html#upgrade-r...

This above page states "We encourage everyone to run the latest stable release", we contains an embedded link. And when you follow that link it returns a 404 with a cutesy error page! See for yourself:

https://about.gitlab.com/blog/categories/release/

Further none of those pages explains how to pass in a specific version of the omnibus package to satisfy the upgrade process in the even that the latest version fails because the upgrade version differential is not supported.

It was really frustrating. And this is but one small example of course. But I think this is typical.


Thanks for the examples. I've asked someone to look into this. And we'll consider setting up a service to scan for 404s in our docs to prevent this in the future.


Let me reiterate Sid's thanks for picking this up for us.

I've raised an MR to fix the broken link issue: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/21820. It'll be merged in due course.

I've raised an issue on our documentation to have the second point you raised looked at in more detail: https://gitlab.com/gitlab-org/gitlab-ce/issues/51666.

Thanks again!


I always find myself being bounced around different pages in your docs to find information about the same topic, and often also have to get bounced to your blog posts. It's hard to know when I've got all the info.

There are so many different places containing parts of the docs about your CI, for example.


Thanks, I recognize what you mean, blog post content that is not in the docs. I'll bring this up with the docs team and we'll try to get better at this by coping the blog post to the docs and linking the blog to the docs for the most up to date content.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: