Bootcamp - API.md 3.46 KB
Newer Older
1
**Title:** _"GitLab API Boot Camp - **your-name**"_
2 3 4 5 6 7 8 9 10 11 12 13 14 15

Tackle stage 1 first and the last stage last, but the others can be completed in
any order you prefer.

**Goal of this checklist:** Set a clear path for GitLab API training

### Stage 1: Commit and Become familiar with what GitLab API is

- [ ] **Done with Stage 1**

1. [ ] Ping your manager on the issue to notify them you have started
1. [ ] Commit to this by notifying the current experts that they can start routing non-technical API related questions to you
1. [ ] Read the [GitLab API Overview](https://docs.gitlab.com/ee/api/README.html)

16
1. [ ] Find answers to and understand the following questions:
17 18 19 20 21 22 23 24
   1. [ ] How are the API routes handled differently from the Rails routes?
   1. [ ] What does it mean to [Grapify the API](http://www.ruby-grape.org/)?
   1. [ ] Where in the code do I look to find which attributes are exposed for an API route (e.g. users)?

### Stage 2: Using the GitLab API

- [ ] **Done with Stage 2**

25
Remember to contribute to any documentation that needs updating.
26

27
1. [ ] Read documentation for 5 different APIs, e.g. for projects, branches,
28
etc. Paste the links here.
29 30 31 32 33
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
34 35

1. [ ] Call the API using all the different authentication methods available
36
   1. [ ] [OAuth 2 Tokens](https://docs.gitlab.com/ee/api/README.html#oauth2-tokens)
37 38 39 40 41 42 43 44
   1. [ ] [Personal Access Tokens](https://docs.gitlab.com/ee/api/README.html#personal-access-tokens)
   1. [ ] [Session Cookie](https://docs.gitlab.com/ee/api/README.html#session-cookie)

### Stage 3: Tickets

- [ ] **Done with Stage 3**

1. [ ] Look for 10 old API tickets and read through them to understand what the
45
issues were and how they were addressed. Paste the links here.
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __

1. [ ] Look for 5 API related issues on gitlab-ce/gitlab-ee issue trackers and
paste the links here

Cody West's avatar
Cody West committed
61 62 63 64 65
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
66 67 68

1. [ ] Answer 10 API tickets and paste the links here. Do this even if a ticket
seems too advanced for you to answer. Find the answers from an expert and relay
69
them to the customers.
70

Cody West's avatar
Cody West committed
71 72 73 74 75 76 77 78 79 80
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
   1. [ ] __
81 82 83 84 85

### Stage 4: Pair on Customer Calls

- [ ] **Done with Stage 4**

86
1. [ ] Pair on two diagnostic calls, where a customer is having trouble with GitLab API.
Cody West's avatar
Cody West committed
87 88
   1. [ ] call with ___
   1. [ ] call with ___
89 90 91 92 93 94

### Stage 5: GitLab API Project

- [ ] **Done with Stage 5**

1. [ ] Develop a small GitLab API integration / automation using two or more
95 96
APIs of your choice. Put it on your GitLab.com account and link to it here.
   - Link: ___
97

98 99 100 101 102 103 104 105 106 107 108 109
### Penultimate Stage: Review
You feel that you can now do all of the objectives:

- Familiar with API
- Know where to look in the code
- Make use of the API
- Can troubleshoot API questions

Any updates or improvements needed? If there are any dead links, out of date or inaccurate content, missing content whether in this bootcamp or in other documentation, list it below as tasks for yourself!

- [ ] Update ...

110 111
### Final Stage

112 113 114
1. [ ] Have your trainer and/or manager review this issue.
1. [ ] Manager: schedule a call (or integrate into 1:1) to review how the bootcamp went once you have reviewed this issue.
1. [ ] Send a MR to declare yourself a **GitLab API Expert** on the team page.
Cynthia Ng's avatar
Cynthia Ng committed
115

116
/label ~bootcamp
117 118

/epic &16