Skip to content

Clarification on reusing projects for README

Omar Fernandez requested to merge readme-path-clarification into master

What does this MR do and why?

Describe in detail what your merge request does and why.

To adopt this feature (https://docs.gitlab.com/ee/user/profile/#user-profile-readme) I tried renaming an existing README project to match my username. It didn't work. It wasn't until I changed the project's path to match my username that the feature worked.

I saw on Slack that at least one other team member ran into the same issue, so was hoping to make this clarification in the documentation for others that may run into the same issue.

Screenshots or screen recordings

These are strongly recommended to assist reviewers and reduce the time to merge your change.

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports