MINOR: Extend release.py with a subcommand for staging docs into the kafka-site repo

[ewencp]

No description provided.

[ewencp]

@ijuma @dguy @gwenshap Doing this manually was becoming really annoying and I know at least streams has had something of an uptick in frequency of these changes, including on already released branches. For people writing patches, with the right organization of checkouts, it can help them validate their PRs. For reviewers, it lets you validate docs changes in this repo against the full site setup more easily, then do the full merge to kafka, generate docs, merge to kafka-site process more easily.

[dguy]

Thanks @ewencp, sounds like a great idea! However my python is pretty terrible, so I can't really offer much in terms of a review of the code!

[ijuma]

This is awesome @ewencp. I ran into an issue when testing. See below.

[ijuma]

Hmm, doesn't seem like this is correct.

version ['1', '0', '0-SNAPSHOT']
major_minor ['1', '0']
Extracting ['tar', 'xf', '/Users/ijuma/src/kafka/core/build/distributions/kafka_2.11-1.0.0-SNAPSHOT-site-docs.tgz', '--strip-components', '1']
Traceback (most recent call last):
File "./release.py", line 235, in
command_stage_docs()
File "./release.py", line 227, in command_stage_docs
cmd('Extracting ', 'tar xf %s --strip-components 1' % docs_tar, cwd=os.path.join(kafka_site_repo_path, docs_version(version)))
File "./release.py", line 108, in cmd
output = subprocess.check_output(cmd, *args, stderr=subprocess.STDOUT, **kwargs)
File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/subprocess.py", line 566, in check_output
process = Popen(stdout=PIPE, *popenargs, **kwargs)
File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/subprocess.py", line 710, in init
errread, errwrite)
File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/subprocess.py", line 1335, in _execute_child
raise child_exception
OSError: [Errno 2] No such file or directory: '/Users/ijuma/src/kafka/../kafka-site/10'

[ijuma]

Actually, maybe this is correct and the issue is just that the code must handle the case where the target directory doesn't exist?

[ijuma]

Also, it seems like our convention for docs versions is quite bad. If we didn't want to use ., we could use something else like _.

[ewencp]

Yeah, likely the missing directory. I agree the docs versioning style is pretty terrible. 1.0 would be a good opportunity to change it as it makes for an easy way to detect which mode you should be using.

Possibly @derrickdoo will have some thoughts. I'm not sure how painful it would be given other places the version appears and the stuff we're doing w/ js now.

[ijuma]

There is also:

docs_version = ''.join(release_version_parts[:3])

Worth consolidating?

[ewencp]

I think all the issues have been addressed (as well as fixing to also copy the javadocs, which I had missed before).

[ewencp]

Ping again, would like to get this merged as it's pretty painful trying to test changes to the docs tooling and styling without this.

[dguy]

LGTM