{"id":20037732,"url":"https://github.com/openedx/edx-documentation","last_synced_at":"2025-03-02T06:24:12.555Z","repository":{"id":20559240,"uuid":"23839256","full_name":"openedx/edx-documentation","owner":"openedx","description":"[DEPRECATED] documentation for Open edX; please see docs.openedx.org","archived":false,"fork":false,"pushed_at":"2025-03-01T00:35:07.000Z","size":153201,"stargazers_count":169,"open_issues_count":34,"forks_count":343,"subscribers_count":140,"default_branch":"master","last_synced_at":"2025-03-01T00:48:30.917Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://docs.edx.org","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openedx.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2014-09-09T15:29:04.000Z","updated_at":"2025-02-21T11:34:15.000Z","dependencies_parsed_at":"2024-12-12T15:21:39.239Z","dependency_job_id":"caaf12d8-4235-4b08-ba54-0bc954f194da","html_url":"https://github.com/openedx/edx-documentation","commit_stats":null,"previous_names":[],"tags_count":87,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fedx-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fedx-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fedx-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Fedx-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/edx-documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241467770,"owners_count":19967728,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-11-13T10:21:26.782Z","updated_at":"2025-03-02T06:24:12.532Z","avatar_url":"https://github.com/openedx.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"###################\nedX Documentation\n###################\n\nThe edx-documentation repository contains source files for most of the\ndocumentation for edX partners and the Open edX community.\n\n* A new site, `docs.openedx.org`_, is currently being built. Before adding new\n  documentation to this repo, consider if the documentation should be added, or\n  moved, to the new site. See the rationale for this decision, as well as more\n  on how the new site is organized, in `this decision document`_.\n\n* API documentation that includes docstrings from code files is stored in the\n  repository of that module.\n\n* Documentation source files for Insights is in the edx-analytics-dashboard\n  repository.\n\nDocumentation for developers, researchers, course staff, and students is\nlocated in the language-specific subdirectories.\n\n.. _docs.openedx.org: https://docs.openedx.org\n\n.. _this decision document: https://docs.openedx.org/en/latest/documentors/decisions/0001-purpose-of-this-repo.html\n\n******************************\nView Published Documentation\n******************************\n\nedX documentation is published through Read the Docs. Links to all published\ndocumentation are available through `docs.edx.org`_.\n\n.. _docs.edx.org: http://docs.edx.org\n\n******************************\nSubmit Documentation Issues\n******************************\n\nYou may submit issues via the `edx-documentation GitHub Issues`_ system.\n\n.. _edx-documentation GitHub Issues: https://github.com/openedx/edx-documentation/issues\n\n**********************************\nContribute to edX Documentation\n**********************************\n\nYou, the user community, can help update and revise edX documentation.\n\nedX documentation is published from `RST`_ source files using `Sphinx`_.\n\n.. _RST: http://docutils.sourceforge.net/rst.html\n.. _Sphinx: http://sphinx-doc.org\n\nTo suggest a revision, fork the project, make changes in your fork, and submit\na pull request back to the original project: this is known as the `GitHub\nFlow`_.\n\n.. _GitHub Flow: https://github.com/blog/1557-github-flow-in-the-browser\n\nAll pull requests need approval from project maintainers, who will look over and\nreview your contributions.\n\n============================================\nSupplying Information with a Pull Request\n============================================\n\nThe edX documentation team created a template that is automatically added to pull requests. You are strongly encouraged to use this template.\n\n======================\nTesting a Contribution\n======================\n\nBefore submitting a pull request, it is recommended you run the test suite on\nyour contribution to ensure it can be compiled into HTML format without errors.\n\nYou may first need to install `GraphViz \u003chttp://graphviz.org/\u003e`_.\nSee the `Download Page \u003chttp://graphviz.org/download/\u003e`_ for more instructions on how to install for your particular Operating System.\n\nTo run a test compilation of a contribution, first install the prerequisites.\n\n.. code::\n\n  make requirements\n\nThen run the tests.\n\n.. code::\n\n  ./run_tests.sh\n\nAdditionally, you can run tests for a single project. For example, to build an\nHTML version of the *Installing, Configuring, and Running the Open edX\nPlatform* guide, you run this test.\n\n.. code::\n\n  ./run_tests.sh en_us/install_operations/\n\nA convenience script is provided to help you develop new documentation. To use\nit you must first install the optional tools, and then run the script.\n\n.. code::\n\n  pip install -r shared/tools.txt\n  ./develop.sh en_us/install_operations/\n\nIt will output a line of text that looks like this.\n\n::\n\n  Serving on http://127.0.0.1:9090\n\nYou can copy this URL into a web browser to see the HTML output for your\nproject.\n\nThe command starts an HTTP server that renders the HTML for the project. This\nHTTP server also monitors the project and detects any changes. When you save a\nchange to a file, the server rebuilds the HTML and refreshes your browser\nautomatically. In this way you can rapidly see how changes you make will be\nrendered as HTML.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Fedx-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Fedx-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Fedx-documentation/lists"}