Extensions Docs Server: Doc conversion script - SVN

Extensions Docs Server: Doc conversion script - SVN

This script will convert static files from the old documentation
system to the new one.

To run from the server2/ directory try:
converter.py ../static/ ../../api templates/articles/ templates/intros/ templates/public/ static/images/ -r -s

This was moved from: http://codereview.chromium.org/10832042/

BUG=131095
Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=150612

[cduvall, 2012-08-03 01:50:09]

Now svn copy is used to get the files. Some files have 'R +' next to them, and
I'm not sure what that means.

This is now blocked on http://codereview.chromium.org/10834144/
Once that goes in, I'll have to make some more changes to the script.

[not at google - send to devlin, 2012-08-06 12:42:14]

Looks great, I'm really excited for when the other patch goes in and we can
submit this.

[cduvall, 2012-08-07 01:24:00]

After spending way too long messing with SVN to get this to upload right, I
think I did it. This is now current with the apps/extensions split.

[not at google - send to devlin, 2012-08-07 02:42:13]

lg but this is an especially tricky patch and I want to be around when you land
it.

Also there's that is_apps problem there. We don't want to force people to have
to write is_apps:true on all those templates, standard_app_api (and
standard_app_article) should be able to figure that out.

I also noticed quite a lot of svn mode changes. Maybe it's right; I've never
used anything other than git-svn which I presume figures this stuff out, but
make sure this:

http://src.chromium.org/chrome/trunk/tools/depot_tools/tests/subversion_confi...

is in ~/.subversion/config

before running the script (I presume you'll need to run it again).

Also, make sure you've done the execute bit right on converter.py:

https://groups.google.com/a/chromium.org/forum/#!topic/chromium-dev/32O9bGzicDA

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
File chrome/common/extensions/docs/server2/converter.py (right):

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/converter.py:45: # From
api_page_generator.js:548.
Make comment like

These are the extension-only APIs that don't have explicit entries in
_permission_features.json, so we can't programmatically figure out that it's
extension-only.

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/converter.py:49: 'fileBrowserHandler',
this is in _permission_features.json so you should be able to figure it out.

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/converter.py:50: 'fontSettings',
ditto, and looks like it's available for platform_app anyway?

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/converter.py:60: 'experimental.commands',
not experimental anymore, so can levae this out.

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
File chrome/common/extensions/docs/server2/integration_test.py (right):

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/integration_test.py:17:
'experimental_serial.html'
commented this in a different patch, but adding a comment as to why these are
expected to fail would be good.

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
File chrome/common/extensions/docs/server2/intro_data_source.py (right):

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/intro_data_source.py:64: intro =
re.sub(re.compile('<h1[^>.]*?>.*?</h1>', flags=re.DOTALL),
could cache this compiled regex in file-scope

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
File chrome/common/extensions/docs/server2/templates/public/apps/fileSystem.html
(right):

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/templates/public/apps/fileSystem.html:1:
{{+partials.standard_apps_api api:apis.file_system is_apps:TRUE}}
we're including the standard_apis_api partial, there shouldn't be any need to
pass in is_apps:TRUE as well?

[cduvall, 2012-08-07 20:21:38]

I think all the permissions are right, I have to config file in the right place.
I also re-ran the script.

Looking forward to getting this in and getting as far away from SVN as possible.

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
File chrome/common/extensions/docs/server2/converter.py (right):

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/converter.py:45: # From
api_page_generator.js:548.
On 2012/08/07 02:42:14, kalman wrote:
> Make comment like
> 
> These are the extension-only APIs that don't have explicit entries in
> _permission_features.json, so we can't programmatically figure out that it's
> extension-only.

Done.

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/converter.py:49: 'fileBrowserHandler',
On 2012/08/07 02:42:14, kalman wrote:
> this is in _permission_features.json so you should be able to figure it out.

Done.

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/converter.py:50: 'fontSettings',
On 2012/08/07 02:42:14, kalman wrote:
> ditto, and looks like it's available for platform_app anyway?

Done.

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/converter.py:60: 'experimental.commands',
On 2012/08/07 02:42:14, kalman wrote:
> not experimental anymore, so can levae this out.

Done.

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
File chrome/common/extensions/docs/server2/intro_data_source.py (right):

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/intro_data_source.py:64: intro =
re.sub(re.compile('<h1[^>.]*?>.*?</h1>', flags=re.DOTALL),
On 2012/08/07 02:42:14, kalman wrote:
> could cache this compiled regex in file-scope

Done.

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
File chrome/common/extensions/docs/server2/templates/public/apps/fileSystem.html
(right):

http://codereview.chromium.org/10834130/diff/1012/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/templates/public/apps/fileSystem.html:1:
{{+partials.standard_apps_api api:apis.file_system is_apps:TRUE}}
On 2012/08/07 02:42:14, kalman wrote:
> we're including the standard_apis_api partial, there shouldn't be any need to
> pass in is_apps:TRUE as well?

Done.

[not at google - send to devlin, 2012-08-08 00:33:13]

lgtm

http://codereview.chromium.org/10834130/diff/8022/chrome/common/extensions/do...
File chrome/common/extensions/docs/server2/integration_test.py (right):

http://codereview.chromium.org/10834130/diff/8022/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/integration_test.py:15: # Exception in
schema compiler (model.py).
file a bug, blocking the release of the server, and link to it here?

[commit-bot: I haz the power, 2012-08-08 01:33:10]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/cduvall@chromium.org/10834130/14439

[commit-bot: I haz the power, 2012-08-08 01:33:25]

Can't process patch for file
chrome/common/extensions/docs/server2/static/images/i18n-after-2.gif.
Change with status ' M   ' is not supported.

[commit-bot: I haz the power, 2012-08-08 01:55:50]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/cduvall@chromium.org/10834130/2894

[commit-bot: I haz the power, 2012-08-08 01:56:07]

Can't process patch for file
chrome/common/extensions/docs/server2/static/images/i18n-after-2.gif.
Change with status ' M   ' is not supported.