{"id":22147229,"url":"https://github.com/centerforopenscience/osfdocs","last_synced_at":"2026-03-08T01:06:04.808Z","repository":{"id":84687366,"uuid":"95459140","full_name":"CenterForOpenScience/OSFDocs","owner":"CenterForOpenScience","description":null,"archived":false,"fork":false,"pushed_at":"2019-03-18T15:46:17.000Z","size":593,"stargazers_count":1,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-09-15T02:44:21.027Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CenterForOpenScience.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-06-26T15:05:28.000Z","updated_at":"2019-03-18T15:46:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"63294c27-2898-4c82-aa91-4a9da0ad7280","html_url":"https://github.com/CenterForOpenScience/OSFDocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/CenterForOpenScience/OSFDocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2FOSFDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2FOSFDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2FOSFDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2FOSFDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CenterForOpenScience","download_url":"https://codeload.github.com/CenterForOpenScience/OSFDocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2FOSFDocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30240343,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-08T00:58:18.660Z","status":"ssl_error","status_checked_at":"2026-03-08T00:55:48.608Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-01T23:15:11.519Z","updated_at":"2026-03-08T01:06:04.772Z","avatar_url":"https://github.com/CenterForOpenScience.png","language":"Python","readme":".. _docs_getting_started:\n\nOSF Feature Docs\n===============\n\nContributions to this documentation are welcome. Documentation is written in `reStructured Text`_ (rST). A quick rST reference can be found `here \u003chttp://docutils.sourceforge.net/docs/user/rst/quickref.html\u003e`_. Builds are powered by Sphinx_ and are hosted by `ReadTheDocs \u003chttp://readthedocs.org\u003e`_.\n\nFork, clone, install\n********************\n\nFirst, `fork the OSFDocs repo \u003chttps://github.com/jlcohoon/OSFDocs\u003e`_, clone it, and install the requirements (requires Python 2.7 or 3.4 with pip):  ::\n\n    # After forking jlcohoon/OSFDocs\n    $ git clone https://github.com/\u003cyour_github_username\u003e/OSFDocs.git\n    $ cd OSFDocs\n    $ pip install -r requirements.txt\n\nBe sure to replace ``\u003cyour_github_username\u003e`` with your Github username.\n\nBuild the docs\n**************\n\nTo build docs: ::\n\n    $ invoke docs -b\n\nThe ``-b`` (for \"browse\") automatically opens up the docs in your browser after building. Alternatively, you can open up the ``docs/_build/index.html`` file manually.\n\nAutobuilding on File Changes\n----------------------------\n\nYou can use ``sphinx-autobuild`` to automatically build the docs when you change a file in the ``docs`` directory.\n\nTo install ``sphinx-autobuild``: ::\n\n    $ pip install sphinx-autobuild\n\n\nYou can now start the livereload server with: ::\n\n    $ invoke watch\n\nPoint your browser to http://localhost:8000 to see your docs.\n\nSend a PR!\n**********\n\nOnce you are done making your edits, send a pull request on Github to the `OSFDocs \u003chttps://github.com/jlcohoon/OSFDocs\u003e`_ repo.\n\n.. _Sphinx: http://sphinx.pocoo.org/\n.. _`reStructured Text`: http://docutils.sourceforge.net/rst.html\n\n\nStyle Conventions\n******************\n\nUse the following underlining conventions for heading levels:\n\n- ``=`` for h1\n- ``*`` for h2\n- ``-`` for h3\n- ``^`` for h4\n\nRefer to the person doing the action as \"the user.\" For example: \"If the user clicks...\" or \"The user can upload...\"\n\nSeparate all modal content by introducing it with a double colon. For example: \"A modal opens that reads::\"\nKeep a line of space between the content and the introductory line and indent all content. Your text should be formatted like this::\n\n    Woah, cool!\n\nRefer to buttons by their title in quotes. For example: the \"Upload\" button.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcenterforopenscience%2Fosfdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcenterforopenscience%2Fosfdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcenterforopenscience%2Fosfdocs/lists"}