whatupmiked intersection between networking, not working, and software

RSS

Opendaylight Documentation Committer

I’m an Opendaylight Contributor! Ok, it’s just documentation, but that’s important too! Just ask Kelsey Hightower or Lisa Caywood!

So now that I’m an awesome Open Source Professional you want to do it too right? Cause if Michael did it, how hard can it be? Right?

Fine. I’ll spill the beans…

HOWTO

  1. Create a gerrit account
  2. Clone the docs repository
  3. Install tox
    pip install tox
    
  4. Build the docs
    cd docs
    git submodule update --init
    tox
    
  5. Make your changes.
  6. Submit your code.
    git add <my awesome change>
    git commit --signoff
    git review
    
  7. Review your awesome changes:

After you submit for review, wait and see if your change get’s accepted. If it does, you feel very popular due to all the automation emails from the tooling! gerrit email

Mistakes I made at the start

  1. Did a normal commit instead of a signoff
    git commit --signoff
    
  2. tox was not working the first time.
    rm -rf .tox
    git submodule update --init
    
  3. No change id in my commit message.
    scp -p -P 29418 whatupmiked@git.opendaylight.org:hooks/commit-msg .git/hooks/
    chmod 755 .git/hooks/commit-msg
    

Next

After going through the process once I felt much more comfortable the 2nd and 3rd time around. The 3rd commit I ended up using a regular expression to search for all files that had a similar compilation error (bold embedded links) to my initial commit.

The expression I used:

egrep -n "(\*{2}.*?\`.*?\`.*?\*{2})" docs/developer-guide/*.rst