centerforopenscience / cosdev

COS Development Docs

COS Development Docs

To get requirements:

$ pip install -r requirements.txt

To build the docs:

$ invoke docs -wb

The -w option will trigger builds when files change. The -b option will open the built docs in your browser.

The docs will be served at http://127.0.0.1:1234.

cosdev's Issues

Add section on implementing OAuth

Several of our interns have written addons that require the user to authorize OSF access to their private resources via OAuth. We are using a wrapper to make OAuth easier, but there are some non-obvious stumbling blocks.

Per @kushG, it isn't obvious how state tokens (nonces) are used to connect the initial callback from the service to the user or node who initiated the request. We could likely wrap this functionality to make it even easier.

Add bower installation instructions to "Setting up the OSF" page

Consolidate OSF README and "Setting up" pages

We have two places where we have documented how to set up the OSF for local development: the private OSF README and the "Setting up the OSF" page of these docs.

To reduce maintenance needs, I propose we consolidate these into a single document in COSDev.

A few considerations:

• COSDev is more didactic while the README is terse.
• How to balance maintenance costs (doc rot, changing requirements) while providing enough detail for junior team members?

Feedback welcome. @JeffSpies @brianjgeiger @caneruguz

h/t to @icereval who brought this to my attention

Update commonJS docs

• webpack_asset mako filter
• prod vs. dev config files
• Commands for running webpack

[OSF Set Up] Setting file changed and need new command?

When I pull the update from osf, it gave me error:

After I run the command -- cp api/base/settings/local-dist.py api/base/settings/local.py, then it is fine. But I remember the command in docs was cp website/settings/local-dist.py website/settings/local.py.

Does it mean the old one has been replaced, or we need run both commands when running osf?

Problems with "Setting up the OSF" page

I'm trying to set up the OSF for my internship and I'm already a problem in your dev page.

In the section "Run OSF installation", the page tells you to input the following commands

cd osf
pip install -r dev-requirements.txt

I might be doing something wrong but as far as I can tell, the directory osf does not exist. Did you mean osf.io? Also in osf.io dev-requirements.txt does not exist. Did you mean requirements.txt? I notice in your requirements folder there are a few other requirements to install. Does one simply install all of them?

I am still working on setting up the osf and would really like to get it running by Monday, but due to lack of knowledge of numerous tools and a vague description of how to do things, I'm not sure. It might be good to invest some time in this page as I'm sure I'm not the only intern who will find difficulty with this.

Update OSF repo

The OSF repo URL is wrong in at least one place: http://cosdev.readthedocs.org/en/latest/osf/setup.html#clone-or-copy-the-osf-files-to-local-directory . These URLs need to be updated.