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

2884 Installation Guide Reorg based on open issues and community feedback #2895

Merged
merged 4 commits into from
Feb 9, 2016

Conversation

pdurbin
Copy link
Member

@pdurbin pdurbin commented Jan 28, 2016

#2884 contains the plan I've been following to rewrite the Installation Guide based on open issues and feedback from the community it the form of a Google doc called Dataverse 4 Installation Guide Reorganization Proposal. It's the parent issue I've been using to organize the rewrite.

This pull request represents all the changes I've made since 4.2.3 to the Installation Guide in the 2884-install-guide-reorg branch. Builds for this branch are deployed hourly to http://guides.dataverse.org/en/2884-install-guide-reorg/installation and that's the place where QA should be done. We can continue iterating on the branch and deploy the docs again until they are good enough to merge into the "develop" branch.

I plan to leave comments on each of the following issues that I think have been wholly or partially addressed by the work in 2884-install-guide-reorg branch. Some of these issues would probably benefit from further attention by @landreev and @sekmiller but I'll make notes about that on a per issue basis:

I have not yet attempted to address the following issues in this pull request. I'll leave comments on them as well, especially for the people who I believe can help the most ( @landreev and @raprasad ):

I'd love feedback on of this and I'm happy to continue pushing changes to the 2884-install-guide-reorg branch until it's good enough to merge into the "develop" branch. Please just let me know where more attention is needed.

Passing to QA.

- enumerated all (?) config options #2283 #2661
- Glassfish init script #2640
- Solr init script #2401
- more on blocking endpoints #976
- documented :SystemEmail #2663
- a bit on admin and monitoring
- reinstalling fresh
@pdurbin pdurbin added this to the 4.3 milestone Jan 28, 2016
@bencomp
Copy link
Contributor

bencomp commented Jan 29, 2016

@pdurbin, this is awesome! I haven't read everything in detail yet, but it's clear you put in a great effort and I salute you for it :)

In terms of what to do next: documentation should grow and be refined together with the software, so I wouldn't mind having this merged and making small changes later to address the things you left for others. Similarly, I don't expect to not have any further questions or suggestions for the documentation, so I hope you're not offended if I say "merge this!" now and later say "could you have another look at that part X of this?"

scolapasta added a commit that referenced this pull request Feb 9, 2016
2884 Installation Guide Reorg based on open issues and community feedback
@scolapasta scolapasta merged commit 1beeee5 into develop Feb 9, 2016
@pdurbin pdurbin modified the milestones: 4.2.4, 4.3 Feb 9, 2016
@pdurbin pdurbin deleted the 2884-install-guide-reorg branch April 28, 2016 19:48
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.

6 participants