{"id":20111735,"url":"https://github.com/openstack/masakari-specs","last_synced_at":"2025-05-06T11:31:05.874Z","repository":{"id":66174757,"uuid":"77031957","full_name":"openstack/masakari-specs","owner":"openstack","description":"Design Specifications for Masakari. Mirror of code maintained at opendev.org.","archived":false,"fork":false,"pushed_at":"2024-01-29T09:07:42.000Z","size":192,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-09T18:50:42.221Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://opendev.org/openstack/masakari-specs","language":"Python","has_issues":false,"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/openstack.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","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}},"created_at":"2016-12-21T08:16:02.000Z","updated_at":"2023-10-24T15:32:56.000Z","dependencies_parsed_at":"2024-01-29T10:32:50.810Z","dependency_job_id":"668bbaba-ca2a-42dd-bfba-0953272cbbcc","html_url":"https://github.com/openstack/masakari-specs","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/openstack%2Fmasakari-specs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fmasakari-specs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fmasakari-specs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fmasakari-specs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openstack","download_url":"https://codeload.github.com/openstack/masakari-specs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224499851,"owners_count":17321605,"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-13T18:17:30.842Z","updated_at":"2024-11-13T18:17:31.707Z","avatar_url":"https://github.com/openstack.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=================================\nOpenStack Masakari Specifications\n=================================\n\n\nThis git repository is used to hold approved design specifications for additions\nto the Masakari project. Reviews of the specs are done in gerrit, using a\nsimilar workflow to how we review and merge changes to the code itself.\n\nThe layout of this repository is::\n\n  specs/\u003crelease\u003e/\n\nWhere there are two sub-directories:\n\n  specs/\u003crelease\u003e/approved: specifications approved but not yet implemented\n  specs/\u003crelease\u003e/implemented: implemented specifications\n\n\nThe lifecycle of a specification\n--------------------------------\n\nDevelopers proposing a specification should propose a new file in the\n``approved`` directory. masakari-core will review the change in the usual\nmanner for the OpenStack project, and eventually it will get merged if a\nconsensus is reached. At this time the Launchpad blueprint is also approved.\nThe developer is then free to propose code reviews to implement their\nspecification. These reviews should be sure to reference the Launchpad\nblueprint in their commit message for tracking purposes.\n\nOnce all code for the feature is merged into Masakari,\nthe Launchpad blueprint is marked complete.\nAs the developer of an approved specification it is your\nresponsibility to mark your blueprint complete when all of the required\npatches have merged.\n\nPeriodically, someone from masakari-core will move implemented specifications\nfrom the ``approved`` directory to the ``implemented`` directory.\nIndividual developers are also welcome to propose this move for their\nimplemented specifications.\nIt is important to create redirects when this is done so that\nexisting links to the approved specification are not broken. Redirects aren't\nsymbolic links, they are defined in a file which sphinx consumes. An example\nis at ``specs/ocata/redirects``.\n\nThis directory structure allows you to see what we thought about doing,\ndecided to do, and actually got done. Users interested in functionality in a\ngiven release should only refer to the ``implemented`` directory.\n\n\nExample specifications\n----------------------\n\nYou can find an example spec in ``specs/ocata-template.rst``.\n\n\nWorking with gerrit and specification unit tests\n------------------------------------------------\n\nFor more information about working with gerrit, see\nhttp://docs.openstack.org/infra/manual/developers.html#development-workflow\n\nTo validate that the specification is syntactically correct (i.e. get more\nconfidence in the Jenkins result), please execute the following command::\n\n  $ tox\n\nAfter running ``tox``, the documentation will be available for viewing in HTML\nformat in the ``doc/build/`` directory.\n\n\n* Free software: Apache license\n* Documentation: http://docs.openstack.org/developer/masakari-specs\n\n* TODO\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fmasakari-specs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenstack%2Fmasakari-specs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fmasakari-specs/lists"}