Glance Project Onboarding - - PDF document

Glance Project Onboarding

https://etherpad.openstack.org/p/SYD-forum-glance-onboarding

Monday, November 6, 1:30pm-2:10pm Sydney Convention and Exhibition Centre - Level 4 - C4.6 Moderators: Brian Rosmaita, Erno Kuvaja, Flavio Percoco

Description

The project onboarding rooms will be set up classroom style, dedicated to the projects that have signed up to teach new contributors about the project code, and give them an opportunity to meet established community members. The idea is that new contributors will come here to get started in the project after they have gone to OpenStack Upstream Institute and already know the basics

• f contribution.

Reality

I'm not sure how much "teaching the code" we can do in 40 minutes, but I was asked recently in an email, "how can I start contributing to Glance?". So I'll paste below what I responded in email so you can have it as a reference. But keep in mind that (a) it's a brain dump, and (b) you don't have to do everything on the list before you can start contributing. (I say that because I think I scared off the potential contributor!) What I'd like to discuss in the forum session are the different kinds of contributions we could use in the Glance project. Not all of them require you to immediately master the code base. There are several ways you can ease into the project, make meaningful contributions, and ramp up as you go. And remember that you are not alone! We are friendly folks, and you can feel free to contact us on IRC in #openstack-glance. We have a weekly Glance meeting at 1400 UTC Thursdays, and I'm usually available to chat after the meeting.

Getting Involved in Glance

I'm glad to hear you're interested in Glance. Here are a few suggestions for ramping up to

• contribute. Except for 0 and 1, which I think make sense to do first, they're not in any particular
• rder.

As you go through the following, it would be helpful if you kept some notes about improvements that could be made, and either file bugs or

push some patches (or both!). We're always interested in improving the glance onboarding experience, and as someone new to Glance, you'll notice gaps in the coverage that we don't see. (0) (I'm assuming you've already done (or already know about) general Openstack onboarding.) https://wiki.openstack.org/wiki/How_To_Contribute https://www.openstack.org/community/ https://docs.openstack.org/contributors/ also, we don't have a page like the following ... maybe we should. You could put up a patch to glance if you think it would be good for glance to have: https://docs.openstack.org/nova/latest/contributor/how-to-get-involved.html (1) Take a quick look through the API Reference (look at Images v2 and Metadefs, the Images v1 API is deprecated) to get a sense of the APIs that Glance provides to end users. https://developer.openstack.org/api-ref/image/ (2) Take a look at the "user guide" in the Developers' Documentation (should give you some more information about the previous item). https://docs.openstack.org/glance/latest/user/ (3) Read through the Glance Contributors' Guide. https://docs.openstack.org/glance/latest/contributor/index.html#policies (4) Look through the Glance Developers' Documentation for information about the architecture and design patterns used in Glance. https://docs.openstack.org/glance/latest/contributor/index.html#developer-reference (5) Look through the Glance specs repo to see what we've been working on in Pike and are planning for Queens. Specs repo: http://git.openstack.org/cgit/openstack/glance-specs Approved specs in HTML format:https://specs.openstack.org/openstack/glance-specs/ Spec proposals: https://review.openstack.org/#/q/status:open+project:openstack/glance-specs (6) Start attending the Glance weekly meeting: https://wiki.openstack.org/wiki/Meetings/Glance (If the meeting is at a bad time for you, you can always look through the meeting logs to keep up, and then ask questions or continue discussion in #openstack-glance. You do need to be present for a meeting where you've put an item on the agenda, though.) (7) There's usually someone available in IRC in #openstack-glance if you have questions or want to discuss something. Working through the above should get you immersed in the Glance project. You could make some contributions right away by helping us get a better onboarding page in the Glance documentation while you're learning your way around!

As far as looking for stuff to work on, there are always bugs :) -- you could grab an open bug, triage it, and fix it, that's a good way to learn something about the code base. There are also some features that you could work on. Any of the specs or lite-specs that don't have someone assigned to them are available. Look under the "Queens" and "Untargeted" specs. (It's also possible that if a spec is assigned to me, I might be talked into turning it over to you to work on.)

• That's all I can think of at the moment. Looking forward to speaking with you in IRC!
• - end --

Where to Find Stuff

The Glance Project Code Repositories

Four repos:

• 1. git.openstack.org/openstack/glance <--> github.com/openstack/glance
• 2. git.openstack.org/openstack/python-glanceclient <--> github.com/openstack/python-

glanceclient

• 3. git.openstack.org/openstack/glance_strore <--> github.com/openstack/glance_store
• 4. git.openstack.org/openstack/glance-specs <--> github.com/openstack/glance-specs

Bugs

Are recorded in Launchpad for each repo:

• 1. https://launchpad.net/openstack/glance
• 2. https://launchpad.net/openstack/python-glanceclient
• 3. https://launchpad.net/glance-store

Easy review finder

See the link at the bottom of this page: https://wiki.openstack.org/wiki/Glance

What to Work On

Documentation

It's not sexy, but it has really big impact on users -- end users, administrators, operators. Also, your improvements to the Contributors Guide will have an impact on future Glance

• contributors. Further, the documentation team has scaled back to providing tools and

infrastructure support ... writing and maintaining the docs is the responsibility of each project. There are two types of contributions:

• Making clarifications on current docs, adding missing docs
• this a a good way to learn what glance does and also to find corner-case bugs
• Enhancing documentation generation
• more of a coding-type thing

Where are the Docs?

• Usually under the 'doc' directory in each project
• The Glance api-ref is under 'api-ref'
• There's an api-guide in the glance-specs repo under specs/api that should really be moved
• ver to the glance repo and set up as its own api-guide build job (or be eliminated entirely

if it doesn't add value -- has some overlap with the api-ref and some of the user docs in the glance repo)

• Configuration documentation is maintained in the code at the place where the config
• ption is defined, and the documents are generated
• the modified docs aren't automatically committed, but with Zuul3, we should be able to

automate doc generation <-- good task for someone to take on!

• Policies aren't currently documented well
• ne of the Queens Community Goals is to get docs for them into the code (like

configuration options)

Testing

We could use improved test coverage on several items in Glance

Reviews and Bugs

Of course! See previous section for where to find them.