{"id":20358214,"url":"https://github.com/irods/irods_docs","last_synced_at":"2025-10-10T15:37:35.963Z","repository":{"id":12344777,"uuid":"71656006","full_name":"irods/irods_docs","owner":"irods","description":"iRODS Documentation","archived":false,"fork":false,"pushed_at":"2025-05-20T15:41:14.000Z","size":2050,"stargazers_count":3,"open_issues_count":61,"forks_count":17,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-20T16:36:51.300Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/irods.png","metadata":{"files":{"readme":"README.md","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":"2016-10-22T17:51:59.000Z","updated_at":"2025-05-20T15:41:18.000Z","dependencies_parsed_at":"2023-10-03T06:55:14.561Z","dependency_job_id":"279ec87e-8795-47fb-97fb-bc70beb1587e","html_url":"https://github.com/irods/irods_docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/irods/irods_docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irods%2Firods_docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irods%2Firods_docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irods%2Firods_docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irods%2Firods_docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/irods","download_url":"https://codeload.github.com/irods/irods_docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irods%2Firods_docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261386725,"owners_count":23150869,"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-14T23:25:59.058Z","updated_at":"2025-10-10T15:37:35.955Z","avatar_url":"https://github.com/irods.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"iRODS Documentation\n===================\n\nThe iRODS documentation is housed in this repository (https://github.com/irods/irods_docs).\n\nPrerequisites\n-------------\n\n- docker\n\nUpdate for correct version\n--------------------------\n\n- Update Makefile with correct GITHUB_ACCOUNT\n- Update Makefile with correct GIT_COMMITTISH\n\nBuild\n-----\n\nDocker will create a builder image.\n\n```\n$ docker build -t irods_docs_builder .\n```\n\nRunning the docker image will save artifacts into `$(pwd)/build`:\n\n```\n$ docker run --rm -v $(pwd):/irods_docs:ro -v $(pwd)/build:/hostcomputer irods_docs_builder\n```\n\nYou can generate documentation for a specific build of iRODS by running the following:\n\n```\n$ docker run --rm -v $(pwd):/irods_docs:ro -v $(pwd)/build:/hostcomputer irods_docs_builder GITHUB_ACCOUNT=\u003caccount\u003e GIT_COMMITTISH=\u003cbranch-or-commit\u003e\n```\n\nThe resulting `build/site` directory will contain the generated standalone documentation.\n\nView\n----\n\nLaunch a webserver on port 8080 to show the resulting `build/site` directory:\n\n```bash\n$ docker run -d --rm --name irods_docs -p 8080:80 -v $(pwd)/build/site:/usr/local/apache2/htdocs/ httpd:2.4\n```\n\nTo stop the webserver:\n\n```bash\n$ docker stop irods_docs\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firods%2Firods_docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Firods%2Firods_docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firods%2Firods_docs/lists"}