-
Notifications
You must be signed in to change notification settings - Fork 387
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Migrate Conflunce content to markdown #29
Comments
Confluence-space-export-234853-39588.html.zip This zip file contains an export of the entire APIC space (which is largely duplicated in the LB space). It has the following:
File names are of the form For example, There are about a dozen files with purely numeric file names, because the titles include a special character (usually a colon). We may just need to handle these manually, but we'll want to change these files names to something based on the title. For example, |
The content is ready, just need to clarify the points below:
|
Thanks @marc-ed-raffalli
I'm not sure what these are... I couldn't find an example in the export. Could you give me an example so I can understand what these are?
Tables are a bit problematic in MD. For now, let's just keep them in HTML. I think that should work OK at least for a first cut. Later I can look at making some of the simple ones markdown, and adding some custom styles for tables.
For now, go ahead and keep the levels, e.g. use
Again, I don't know what these would be.... We might be able to just discard these, but an example or two would help me to understand better what they are.
We don't want to keep that. Instead, we want something like this (e.g. in
Unfortunately, the Jekyll theme sidebar seems to support only three levels of topics. That covers about 90% of the LoopBack doc structure, but there are a few that go down to a fourth level. I'll have to rework the topic hierarchy a bit to fit those in--that will be a manual process. Until I do that, you can just flatten the fourth-level topics to be children of the grandparent. One more thing that I forgot when I originally wrote up the conversion rules: We have to support translation into multiple languages (see #33). This has several implications for the conversion script:
Initially, we'll only convert the English docs, so you only need to worry about |
BTW, I just pushed an update to the repo that reflects the changes required to support localization: d35c8d6 |
No problem, it is updated. I just need to finish the file content review (180+ files). Edited: issue solved, (long day I presume ;) ) I'll post later a report of places where the different issues were, it will help to understand and fix if applicable. |
The initial conversion was accomplished in #34 (thanks @marc-ed-raffalli !) We (I) still need to:
|
Confluence-space-export-171136-47671.html.zip Here is the export of the pages modified since the initial export on Aug. 4. However @marc-ed-raffalli I cannot get these to convert using your conversion script. I get the following error:
@marc-ed-raffalli I tried to debug this, but didn't get very far....appreciate any help! |
Will get an eye to it |
The HTML structure is slightly different. |
Awesome, thank you! I'm not sure why the structure is different, but if you can easily fix it, that's great!! |
I'm going to close this as the basic work is done. At this point, it's testing, fixing, refinement, etc, which we'll handle in other issues. |
This involves not only duplicating the content, but also getting all the images over. See Migrating LoopBack Docs to Markdown for use with Jekyll.
This is part of Proposal to make LoopBack documentation open source.
The text was updated successfully, but these errors were encountered: