Add Go guidelines to developer docs
What does this MR do?
Adds our Go guidelines to the development doc.
Related issues
Closes #54494 (closed)
Author's checklist
-
Apply the correct labels and milestone -
Crosslink the document from the higher-level index: added to doc/development/README.md
-
Crosslink the document from other subject-related docs: added to doc/development/contributing/style_guides.md
-
Feature moving tiers? Make sure the change is also reflected infeatures.yml
-
Correctly apply the product badges and tiers -
Port the MR to EE (or backport from CE): always recommended, required when the ee-compat-check
job fails: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/9462
Review checklist
-
Your team's review (required) -
PM's review (recommended, but not a blocker)(development guidelines) -
Technical writer's review (required) -
Merge the EE-MR first, CE-MR afterwards
/label ~Documentation golang development guidelines
Merge request reports
Activity
mentioned in issue #54494 (closed)
1 Warning This merge request includes more than 10 commits. Please rebase these commits into a smaller number of commits. 1 Message This merge request adds or changes files that require a review from the Docs team. Docs review
The following files require a review from the Documentation team:
doc/development/README.md
doc/development/contributing/style_guides.md
doc/development/go_guide/index.md
When your content is ready for review, assign the MR to a technical writer according to the DevOps stages in the table below. If necessary, mention them in a comment explaining what needs to be reviewed.
Tech writer Stage(s) @marcia
~Create ~Release + development guidelines @axil
~Distribution Gitaly ~Gitter ~Monitor ~Package ~Secure @eread
~Manage ~Configure ~Geo ~Verify @mikelewis
~Plan You are welcome to mention them sooner if you have questions about writing or updating the documentation. GitLabbers are also welcome to use the #docs channel on Slack.
If you are not sure which category the change falls within, or the change is not part of one of these categories, mention one of the usernames above.
Generated by
DangerEdited by 🤖 GitLab Bot 🤖added Quality backend documentation labels
added 2 commits
- Resolved by Philippe Lafoucrière
- Resolved by Steve Xuereb
- Resolved by Steve Xuereb
- Resolved by Philippe Lafoucrière
- Resolved by Steve Xuereb
- Resolved by Philippe Lafoucrière
mentioned in merge request gitlab-com/www-gitlab-com!18571 (merged)
@plafoucriere when do you think we can get this MR merged? I want to include it in a legal doc but don't want to wait too long.
@eliran.mesika I will polish some details today (the left TODOs), and we should be able to merge tomorrow. Does that work for you? @marin could you please take a look? We can always update and add content later, but at least @eliran.mesika will have a page to link in his docs. Thanks
@plafoucriere tomorrow is good, thank you. Having a page we can reference to and note it'll undergo updates in the future is key.
assigned to @fcatteau
added 2 commits
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
Good starting point @plafoucriere, thanks!
changed milestone to %11.8
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
assigned to @plafoucriere
mentioned in issue #57020 (moved)
@marcia could you please do a final review? Thanks
added development guidelines label
assigned to @marcia
mentioned in issue #57045 (moved)
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière
- Resolved by Philippe Lafoucrière