Editing forking workflow
What does this MR do?
This is one of my first MRs so I went a little overboard. Here is a list of what I changed and why.
Style updates:
-
Updated images to focus more closely on the area being referred to.
-
Click rather than click on. https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/mouse-mouse-interaction-terms
-
No need to have descriptor (Click the x
button). Can just say Click x. https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/b/button -
Changed split infinitive (You can then assign to Then you can assign).
-
Changed 12.6 onward to 12.6 and later because it’s better for localization. https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/l/later
-
Once means one time, not after. https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/o/once
-
Made button text bold. Fixed format of Note.
-
Tried to write in present tense rather than future (got rid of instances of will be).
-
Removed fork error screenshot. The user will see this error in the UI, so no need to repeat it in the docs. The message that pops up is self-explanatory—no user would ever search the docs for details on it, unless the steps to fix it are complicated. I did add that the project name needs to be unique in the namespace. That might help them avoid the error if they’re using the docs as a guide.
-
Changed case of Submit merge request button to match the button itself.
-
Removed the final screen shot because it wasn’t necessary to help with the user’s understanding, and it wasn’t specific to forking. (I don’t think the screen is any different than the one for merging?)
Technical updates:
-
Added details about creating upstream, because I think it is required. Or I should say, I think it's useful if you want to try to prevent merge conflicts.
-
Changed this sentence:
Choose your forked project’s main branch as the source and the original project’s main branch as the destinationIn my experience, you can merge from any branch in your fork to any other branch in the main repo. It doesn’t need to be the main branch.