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

improve docs #12

Open
pameyer opened this issue Nov 17, 2016 · 4 comments
Open

improve docs #12

pameyer opened this issue Nov 17, 2016 · 4 comments

Comments

@pameyer
Copy link
Member

pameyer commented Nov 17, 2016

readme significantly out of date.

@pameyer
Copy link
Member Author

pameyer commented Mar 15, 2017

README is slightly less out of date.

@pdurbin
Copy link
Collaborator

pdurbin commented May 17, 2017

I'm not sure what the definition of done is for this issue but I guess I'll add some thoughts here as of 8c1e652 especially with an eye toward a developer having DCM spun up to work on IQSS/dataverse#3725

  • In the README, see [doc/installation.md](installation instructions). isn't a link.
  • We should advise developers to use vagrant up I think. This isn't mentioned in installation.md. Perhaps we should keep installation.md targeted at sysadmins who want to run the DCM for real and create a separate file for developers. A natural choice would be CONTRIBUTING.md, which every GitHub repo should have anyway because you users get a link to it when they go to create an issue.
  • After copying secrets.yml.template to secrets.yml "configure the hostlist as appropriate" is not enough information for me to change anything. I think maybe I can leave it as-is for development, but I don't remember.
  • You need to have Ansible installed before you run vagrant up.

@pdurbin
Copy link
Collaborator

pdurbin commented May 18, 2017

More stuff:

@pameyer
Copy link
Member Author

pameyer commented May 22, 2017

  • document /deposit/processed , /deposit/requests (pre/post storage for request files).

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

No branches or pull requests

2 participants