{"id":22393089,"url":"https://github.com/nemethf/bess-doc2wiki","last_synced_at":"2025-03-26T22:22:03.436Z","repository":{"id":145233408,"uuid":"108387610","full_name":"nemethf/bess-doc2wiki","owner":"nemethf","description":"Automatically regenerate bess documentation and update the wiki page","archived":false,"fork":false,"pushed_at":"2020-03-09T15:48:37.000Z","size":20,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T04:14:56.245Z","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":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nemethf.png","metadata":{"files":{"readme":"README.md","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":"2017-10-26T09:04:24.000Z","updated_at":"2020-03-09T15:48:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"7dcc2770-6200-4243-9000-4c1bcfabaec7","html_url":"https://github.com/nemethf/bess-doc2wiki","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nemethf%2Fbess-doc2wiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nemethf%2Fbess-doc2wiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nemethf%2Fbess-doc2wiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nemethf%2Fbess-doc2wiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nemethf","download_url":"https://codeload.github.com/nemethf/bess-doc2wiki/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245743533,"owners_count":20665118,"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-12-05T04:22:36.867Z","updated_at":"2025-03-26T22:22:03.418Z","avatar_url":"https://github.com/nemethf.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bess-doc2wiki\nAutomatically regenerate bess documentation and update the wiki page\n\n# Installation\n\n1. Clone `bess-doc2wiki`, `bess`, `bess.wiki`, and [Justine Sherry's\n`protoc-gen-doc`](https://github.com/justinemarie/protoc-gen-doc)\nrepositories into a common directory.  `bess` and `bess.wiki` should\nnot deviate from origin master, i.e., there should be no local\ndevelopment there.\n\n2. `docker pull pseudomuto/protoc-gen-doc`\n\n3. To automatically regenerate the wiki page after each commit to the\n   master you can\n\n    (i) set up a web-hook in the github project page that runs `update.sh`,\n    or\n\n    (ii) \"watch\" the project, and extend your .procmailrc file:\n    ```\n    :0\n    * ^List-Archive:.https://github.com/NetSys/bess\n    {\n        :0 cB: bess.lock\n        * ^Merged.#[0-9]\n        | $HOME/src/bess-doc2wiki/update.sh\n    }\n    ```\n\nIt seems anyone can edit the wiki using github's the web interface,\nbut `git push` is restricted to those how have write access to the\nproject.  Therefore, my automatically updated version of the\ndocumentation is\n[here](https://github.com/nemethf/bess/wiki/Built-In-Modules-and-Ports)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnemethf%2Fbess-doc2wiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnemethf%2Fbess-doc2wiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnemethf%2Fbess-doc2wiki/lists"}