Skip to content
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

Fixes #7117: Use the webhelp doc as embedded doc in the webapp #739

Conversation

amousset
Copy link
Member

@amousset
Copy link
Member Author

Should not be merged before Normation/rudder-doc#134.

mkdir -p ./rudder-doc/pdf
# Move the generated PDF from html directory to pdf
mv ./rudder-doc/html/rudder-doc.pdf ./rudder-doc/pdf/
$(WGET) -P ./rudder-doc/html -r -np -nH --cut-dirs=1 http://www.rudder-project.org/doc-${RUDDER_MAJOR_VERSION}/index.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't include the index.html at the end of the URL. I'd rather use a standard URL and let the webserver serve whatever it thinks (aka what we configure) is best.

@amousset amousset force-pushed the ust_7117/use_the_webhelp_doc_as_embedded_doc_in_the_webapp branch from cd7f27d to 2bf5fc9 Compare August 19, 2015 15:10
@amousset
Copy link
Member Author

PR updated.

mv ./rudder-doc/html/rudder-doc.pdf ./rudder-doc/pdf/
$(WGET) -P ./rudder-doc/html -r -np -nH --cut-dirs=1 http://www.rudder-project.org/doc-${RUDDER_MAJOR_VERSION}/
# Download the pdf version of the manual
$(WGET) -P ./rudder-doc/pdf 1 http://www.rudder-project.org/rudder-doc-${RUDDER_MAJOR_VERSION}/rudder-doc.pdf
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "1" here looks like a typo.

@amousset amousset force-pushed the ust_7117/use_the_webhelp_doc_as_embedded_doc_in_the_webapp branch from 2bf5fc9 to 1309ff2 Compare August 19, 2015 15:16
@amousset
Copy link
Member Author

PR updated.

@jooooooon
Copy link
Member

This looks good now, but I don't think we should make the change on the 2.10 branch. This is not a bug fix, so does not fit our policy for changes on maintenance releases. Also, it would be a very surprising change in user experience for any users used to consulting that documentation, that suddenly after a minor version upgrade, changes completely.

Please retarget to master unless you see a reason I'm missing here.

@amousset
Copy link
Member Author

Sure, retargeting.

@amousset amousset closed this Aug 19, 2015
This pull request was closed.
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.

2 participants