Skip to content

Update reference documentation to 5.0 #12

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

Merged
merged 5 commits into from
Oct 17, 2017

Conversation

fredericDelaporte
Copy link
Member

@fredericDelaporte fredericDelaporte commented Oct 10, 2017

I have not kept strange "layout" text previous files were having.
I have re-saved all files to utf8 with bom (I should check if there is some option in docbook for that instead) and added back previous meta.
I have added the html5 doctype for having those pages rendered in standard mode instead of quirks mode.
Previous css kept, it has an additional rule at its end.

@hazzik
Copy link
Member

hazzik commented Oct 10, 2017

I think we want to copy 4.1 into a subfolder (#7). I'll do it later today.

@fredericDelaporte
Copy link
Member Author

fredericDelaporte commented Oct 12, 2017

I have added back includes and layout override in each files.

I have also added a proposition for previous version of reference documentation. Each page has a canonical ref to current version, for consolidating search engine ranking on current version instead of spreading it over all versions.

I have seen that some direct fixes were made in the documentation, and at least some of them were not done in its DocBook source. So we likely should port those fixes in them and regen again the files.

@fredericDelaporte
Copy link
Member Author

Updated with latest changes.

@fredericDelaporte
Copy link
Member Author

fredericDelaporte commented Oct 15, 2017

Re-updated with latest change, squashed a bit, added v3.3 reference taken from SourceForge 3.4.1 zip, v2.1 from SourceForge 2.1.2 zip, and added another proposal: including other formats like pdf and chm.

But chm may cause us undue bug reports due to a mishandled Windows security feature causing it to load blank content until unlocking the file.

I have not extracted the many pages reference for v3.3 and v2.1 because they were not published as far as I know, and that is quite some work for re-injecting the layout override, meta and google includes.

I have not extracted the pdf/chm for them either because I think we do not have corresponding pdf/chm for v4.1 due to the direct changes which were done on the html of v4.1. So I have decided to provide them only starting from v5.0.

@fredericDelaporte
Copy link
Member Author

Re-updated with latest changes (including "DocGlitches").

@hazzik hazzik merged commit 3bfbacd into nhibernate:master Oct 17, 2017
@hazzik
Copy link
Member

hazzik commented Oct 17, 2017

Thanks a lot

@fredericDelaporte fredericDelaporte deleted the RefDoc5.0 branch October 17, 2017 11:08
@kenny-evitt
Copy link

@fredericDelaporte @hazzik Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants