)]}'
{"doc/contributor-guide/source/diagram-guidelines.rst":[{"author":{"_account_id":14643,"name":"Olga Gusarenko","email":"ogusarenko@mirantis.com","username":"Olga"},"change_message_id":"bac72ad5320591284b5ebfeaeaf2d89c2b9f09ea","unresolved":false,"context_lines":[],"source_content_type":"","patch_set":2,"id":"3aaa91ec_7a6e30ca","updated":"2016-06-29 10:39:12.000000000","message":"Please include this file to the index.rst file to fix the failure.","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"}],"doc/contributor-guide/source/diagram-guidelines/diagram-usage.rst":[{"author":{"_account_id":14947,"name":"Maria Zlatkova","email":"mzlatkova@mirantis.com","username":"mzlatkova"},"change_message_id":"9a12c6cc46a0a36da50883a32a1f84ac41079b1d","unresolved":false,"context_lines":[{"line_number":5,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"Diagrams can be useful tools to help orient users visualize complex"},{"line_number":8,"context_line":"processes. However, diagrams can sometime be too simplistic, confusing"},{"line_number":9,"context_line":"the user instead of helping. The decision about whether a diagram is"},{"line_number":10,"context_line":"useful depends on the context of each project, and the discretion"},{"line_number":11,"context_line":"of each contributor and reviewer."}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_6f479777","line":8,"range":{"start_line":8,"start_character":33,"end_line":8,"end_character":41},"updated":"2016-06-29 10:07:27.000000000","message":"sometimes","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":14947,"name":"Maria Zlatkova","email":"mzlatkova@mirantis.com","username":"mzlatkova"},"change_message_id":"9a12c6cc46a0a36da50883a32a1f84ac41079b1d","unresolved":false,"context_lines":[{"line_number":7,"context_line":"Diagrams can be useful tools to help orient users visualize complex"},{"line_number":8,"context_line":"processes. However, diagrams can sometime be too simplistic, confusing"},{"line_number":9,"context_line":"the user instead of helping. The decision about whether a diagram is"},{"line_number":10,"context_line":"useful depends on the context of each project, and the discretion"},{"line_number":11,"context_line":"of each contributor and reviewer."},{"line_number":12,"context_line":""},{"line_number":13,"context_line":"When to use diagrams"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_0f07f31c","line":10,"range":{"start_line":10,"start_character":45,"end_line":10,"end_character":46},"updated":"2016-06-29 10:07:27.000000000","message":"no comma","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":17,"context_line":"situations:"},{"line_number":18,"context_line":""},{"line_number":19,"context_line":"* When there is evidence of a process, whether the process is"},{"line_number":20,"context_line":"  is automated or manual"},{"line_number":21,"context_line":""},{"line_number":22,"context_line":"  Example: Basic setup workflow"},{"line_number":23,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_a19eb351","line":20,"range":{"start_line":20,"start_character":18,"end_line":20,"end_character":24},"updated":"2016-06-29 10:03:13.000000000","message":"manual.* full stop here","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":14947,"name":"Maria Zlatkova","email":"mzlatkova@mirantis.com","username":"mzlatkova"},"change_message_id":"9a12c6cc46a0a36da50883a32a1f84ac41079b1d","unresolved":false,"context_lines":[{"line_number":17,"context_line":"situations:"},{"line_number":18,"context_line":""},{"line_number":19,"context_line":"* When there is evidence of a process, whether the process is"},{"line_number":20,"context_line":"  is automated or manual"},{"line_number":21,"context_line":""},{"line_number":22,"context_line":"  Example: Basic setup workflow"},{"line_number":23,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_c44b0d2a","line":20,"range":{"start_line":20,"start_character":18,"end_line":20,"end_character":24},"in_reply_to":"3aaa91ec_a19eb351","updated":"2016-06-29 10:07:27.000000000","message":"This is not a full sentence, that is why no full stop (the same for the bullets below). http://docs.openstack.org/contributor-guide/writing-style/lists.html","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"87153c4aefefc4f62f7cdbd4bffcc69e1af365ab","unresolved":false,"context_lines":[{"line_number":17,"context_line":"situations:"},{"line_number":18,"context_line":""},{"line_number":19,"context_line":"* When there is evidence of a process, whether the process is"},{"line_number":20,"context_line":"  is automated or manual"},{"line_number":21,"context_line":""},{"line_number":22,"context_line":"  Example: Basic setup workflow"},{"line_number":23,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_152ffd3e","line":20,"range":{"start_line":20,"start_character":18,"end_line":20,"end_character":24},"in_reply_to":"3aaa91ec_c44b0d2a","updated":"2016-06-29 11:01:51.000000000","message":"Good point, thanks for the remind Maria :)","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":19,"context_line":"* When there is evidence of a process, whether the process is"},{"line_number":20,"context_line":"  is automated or manual"},{"line_number":21,"context_line":""},{"line_number":22,"context_line":"  Example: Basic setup workflow"},{"line_number":23,"context_line":""},{"line_number":24,"context_line":"* When you need to clarify configurations and reference architectures"},{"line_number":25,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_e1bf1ba8","line":22,"range":{"start_line":22,"start_character":2,"end_line":22,"end_character":31},"updated":"2016-06-29 10:03:13.000000000","message":"I would suggest actual physical examples here and below","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":21,"context_line":""},{"line_number":22,"context_line":"  Example: Basic setup workflow"},{"line_number":23,"context_line":""},{"line_number":24,"context_line":"* When you need to clarify configurations and reference architectures"},{"line_number":25,"context_line":""},{"line_number":26,"context_line":"  Example: Code review, upstream versus local environment"},{"line_number":27,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_61b32bea","line":24,"range":{"start_line":24,"start_character":56,"end_line":24,"end_character":69},"updated":"2016-06-29 10:03:13.000000000","message":"architectures.*","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":23,"context_line":""},{"line_number":24,"context_line":"* When you need to clarify configurations and reference architectures"},{"line_number":25,"context_line":""},{"line_number":26,"context_line":"  Example: Code review, upstream versus local environment"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":""},{"line_number":29,"context_line":"When not to use diagrams"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_610fab88","line":26,"range":{"start_line":26,"start_character":11,"end_line":26,"end_character":32},"updated":"2016-06-29 10:03:13.000000000","message":"I\u0027m unsure what this means?","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10897,"name":"Joseph Robinson","email":"josephremail@gmail.com","username":"RobiJoe"},"change_message_id":"b634bba15a3c70963da7352498a4744e39d552a8","unresolved":false,"context_lines":[{"line_number":4,"context_line":"Use diagrams sparingly"},{"line_number":5,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"Diagrams can be useful tools to help orient users visualize complex"},{"line_number":8,"context_line":"processes. However, diagrams can sometimes be too simplistic, confusing"},{"line_number":9,"context_line":"the user instead of helping. The decision about whether a diagram is"},{"line_number":10,"context_line":"useful depends on the context of each project and the discretion"}],"source_content_type":"text/x-rst","patch_set":5,"id":"3aaa91ec_517de71a","line":7,"updated":"2016-06-30 07:39:56.000000000","message":"One suggestion, add a conjunction into the opening sentence - \"Diagrams can be useful tools to help orient users, and visualize complex processes.\"","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":8,"context_line":"processes. However, diagrams can sometimes be too simplistic, confusing"},{"line_number":9,"context_line":"the user instead of helping. The decision about whether a diagram is"},{"line_number":10,"context_line":"useful depends on the context of each project and the discretion"},{"line_number":11,"context_line":"of each contributor and reviewer."},{"line_number":12,"context_line":""},{"line_number":13,"context_line":"When to use diagrams"},{"line_number":14,"context_line":"~~~~~~~~~~~~~~~~~~~~"}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_5ceaced8","line":11,"updated":"2016-07-13 21:54:03.000000000","message":"Pictures are worth a thousand words, so I prefer to see them whenever they can reduce the number of words to describe something.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":21152,"name":"zhang.xiuhua","email":"zhang.xiuhua@99cloud.net","username":"zhang.xiuhua"},"change_message_id":"6f5739a67e36b5bd159ea78ff1ce37336a7a7068","unresolved":false,"context_lines":[{"line_number":16,"context_line":"Include diagrams in OpenStack documentation in the following"},{"line_number":17,"context_line":"situations:"},{"line_number":18,"context_line":""},{"line_number":19,"context_line":"* When there is evidence of a process, whether the process is"},{"line_number":20,"context_line":"  is automated or manual"},{"line_number":21,"context_line":""},{"line_number":22,"context_line":"  Example: Basic setup workflow"}],"source_content_type":"text/x-rst","patch_set":5,"id":"3aaa91ec_2189e626","line":19,"range":{"start_line":19,"start_character":2,"end_line":19,"end_character":16},"updated":"2016-06-30 10:06:03.000000000","message":"A suggestion:\nremove \u0027when\u0027 word before each sentence, because it repeats title \"When to use diagrams\"","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":21152,"name":"zhang.xiuhua","email":"zhang.xiuhua@99cloud.net","username":"zhang.xiuhua"},"change_message_id":"6f5739a67e36b5bd159ea78ff1ce37336a7a7068","unresolved":false,"context_lines":[{"line_number":16,"context_line":"Include diagrams in OpenStack documentation in the following"},{"line_number":17,"context_line":"situations:"},{"line_number":18,"context_line":""},{"line_number":19,"context_line":"* When there is evidence of a process, whether the process is"},{"line_number":20,"context_line":"  is automated or manual"},{"line_number":21,"context_line":""},{"line_number":22,"context_line":"  Example: Basic setup workflow"}],"source_content_type":"text/x-rst","patch_set":5,"id":"3aaa91ec_e603740e","line":19,"range":{"start_line":19,"start_character":59,"end_line":19,"end_character":61},"updated":"2016-06-30 10:06:03.000000000","message":"unnecessary \u0027is\u0027","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":16,"context_line":"Include diagrams in OpenStack documentation in the following"},{"line_number":17,"context_line":"situations:"},{"line_number":18,"context_line":""},{"line_number":19,"context_line":"* When there is evidence of a process, whether the process is"},{"line_number":20,"context_line":"  is automated or manual"},{"line_number":21,"context_line":""},{"line_number":22,"context_line":"  Example: Basic setup workflow"}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_bca2d2ab","line":19,"range":{"start_line":19,"start_character":59,"end_line":19,"end_character":61},"in_reply_to":"3aaa91ec_e603740e","updated":"2016-07-13 21:54:03.000000000","message":"Too many \"is\" here... suggest rewording to improve grammar.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":6772,"name":"Stephen Gordon","email":"sgordon@redhat.com","username":"sgordon"},"change_message_id":"8c54053437ef415b8150ba71a7331a43a11cd5f4","unresolved":false,"context_lines":[{"line_number":17,"context_line":"situations:"},{"line_number":18,"context_line":""},{"line_number":19,"context_line":"* When there is evidence of a process, whether the process is"},{"line_number":20,"context_line":"  is automated or manual"},{"line_number":21,"context_line":""},{"line_number":22,"context_line":"  Example: Basic setup workflow"},{"line_number":23,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"3aaa91ec_e2b787f6","line":20,"updated":"2016-07-01 17:14:31.000000000","message":"Disagree here because the point is to ensure that the bullets flow from the lede text. Could however replace when with if.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":26,"context_line":"  Example: Code review, upstream versus local environment"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":""},{"line_number":29,"context_line":"When not to use diagrams"},{"line_number":30,"context_line":"~~~~~~~~~~~~~~~~~~~~~~~~"},{"line_number":31,"context_line":""},{"line_number":32,"context_line":"Do not include diagrams in the following situations:"}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_48595e5b","line":29,"updated":"2016-07-13 21:54:03.000000000","message":"I find a few examples of when to use diagrams rather helpful, but when not to feels a bit too subjective. When in doubt, use a diagram.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":21152,"name":"zhang.xiuhua","email":"zhang.xiuhua@99cloud.net","username":"zhang.xiuhua"},"change_message_id":"6f5739a67e36b5bd159ea78ff1ce37336a7a7068","unresolved":false,"context_lines":[{"line_number":31,"context_line":""},{"line_number":32,"context_line":"Do not include diagrams in the following situations:"},{"line_number":33,"context_line":""},{"line_number":34,"context_line":"* When a workflow is too simplistic"},{"line_number":35,"context_line":"* When there is no interaction with an OpenStack project"},{"line_number":36,"context_line":"* When a configuration can be easily explained through text"}],"source_content_type":"text/x-rst","patch_set":5,"id":"3aaa91ec_a17dd61d","line":34,"range":{"start_line":34,"start_character":2,"end_line":34,"end_character":9},"updated":"2016-06-30 10:06:03.000000000","message":"remove it as the same reason","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":6772,"name":"Stephen Gordon","email":"sgordon@redhat.com","username":"sgordon"},"change_message_id":"8c54053437ef415b8150ba71a7331a43a11cd5f4","unresolved":false,"context_lines":[{"line_number":32,"context_line":"Do not include diagrams in the following situations:"},{"line_number":33,"context_line":""},{"line_number":34,"context_line":"* When a workflow is too simplistic"},{"line_number":35,"context_line":"* When there is no interaction with an OpenStack project"},{"line_number":36,"context_line":"* When a configuration can be easily explained through text"}],"source_content_type":"text/x-rst","patch_set":5,"id":"3aaa91ec_c2bc0bde","line":35,"updated":"2016-07-01 17:14:31.000000000","message":"As above.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"}],"doc/contributor-guide/source/diagram-guidelines/files.rst":[{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":5,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"No matter which illustration tool you use, all diagrams files"},{"line_number":8,"context_line":"must be saved an editable .svg file."},{"line_number":9,"context_line":""},{"line_number":10,"context_line":"Furthermore, any outside stencils or objects added to a diagram"},{"line_number":11,"context_line":"should also be .svg files, so that reviewers can edit individual elements"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_e1727b10","line":8,"range":{"start_line":8,"start_character":26,"end_line":8,"end_character":30},"updated":"2016-06-29 10:03:13.000000000","message":"``.svg``","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10705,"name":"Darren Chan","email":"dazzachan@yahoo.com.au","username":"daz"},"change_message_id":"c522bdbba62fb57bc62e886f3497d4bd179284a9","unresolved":false,"context_lines":[{"line_number":5,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"No matter which illustration tool you use, all diagrams files"},{"line_number":8,"context_line":"must be saved an editable .svg file."},{"line_number":9,"context_line":""},{"line_number":10,"context_line":"Furthermore, any outside stencils or objects added to a diagram"},{"line_number":11,"context_line":"should also be .svg files, so that reviewers can edit individual elements"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_222656ce","line":8,"range":{"start_line":8,"start_character":13,"end_line":8,"end_character":14},"updated":"2016-06-29 01:01:06.000000000","message":"as","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":8,"context_line":"must be saved an editable .svg file."},{"line_number":9,"context_line":""},{"line_number":10,"context_line":"Furthermore, any outside stencils or objects added to a diagram"},{"line_number":11,"context_line":"should also be .svg files, so that reviewers can edit individual elements"},{"line_number":12,"context_line":"diagram."},{"line_number":13,"context_line":""},{"line_number":14,"context_line":"File names"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_815a9781","line":11,"range":{"start_line":11,"start_character":15,"end_line":11,"end_character":19},"updated":"2016-06-29 10:03:13.000000000","message":"``.svg``","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":14947,"name":"Maria Zlatkova","email":"mzlatkova@mirantis.com","username":"mzlatkova"},"change_message_id":"9a12c6cc46a0a36da50883a32a1f84ac41079b1d","unresolved":false,"context_lines":[{"line_number":9,"context_line":""},{"line_number":10,"context_line":"Furthermore, any outside stencils or objects added to a diagram"},{"line_number":11,"context_line":"should also be .svg files, so that reviewers can edit individual elements"},{"line_number":12,"context_line":"diagram."},{"line_number":13,"context_line":""},{"line_number":14,"context_line":"File names"},{"line_number":15,"context_line":"~~~~~~~~~~"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_81f3b709","line":12,"range":{"start_line":12,"start_character":0,"end_line":12,"end_character":7},"updated":"2016-06-29 10:07:27.000000000","message":"of the diagram ?","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":16,"context_line":""},{"line_number":17,"context_line":"Contributors must create unique and meaningful file names to"},{"line_number":18,"context_line":"differentiate between diagrams. An example of this is the name"},{"line_number":19,"context_line":"*cg-workflow-digram.svg*. *cg* indicates that this diagram belongs"},{"line_number":20,"context_line":"in the contributor guidelines, the acronym created by taking"},{"line_number":21,"context_line":"the first letters of the OpenStack book name.  *workflow-diagram.svg*"},{"line_number":22,"context_line":"provides a description of what the diagram is about, as well as the"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_21cac31a","line":19,"range":{"start_line":19,"start_character":0,"end_line":19,"end_character":24},"updated":"2016-06-29 10:03:13.000000000","message":"``cg-workflow-diagram.svg`` (diagram) and ``cg``","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":18,"context_line":"differentiate between diagrams. An example of this is the name"},{"line_number":19,"context_line":"*cg-workflow-digram.svg*. *cg* indicates that this diagram belongs"},{"line_number":20,"context_line":"in the contributor guidelines, the acronym created by taking"},{"line_number":21,"context_line":"the first letters of the OpenStack book name.  *workflow-diagram.svg*"},{"line_number":22,"context_line":"provides a description of what the diagram is about, as well as the"},{"line_number":23,"context_line":"file type extension."},{"line_number":24,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_61d4cbbc","line":21,"range":{"start_line":21,"start_character":45,"end_line":21,"end_character":47},"updated":"2016-06-29 10:03:13.000000000","message":"Remove the double space here","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":18,"context_line":"differentiate between diagrams. An example of this is the name"},{"line_number":19,"context_line":"*cg-workflow-digram.svg*. *cg* indicates that this diagram belongs"},{"line_number":20,"context_line":"in the contributor guidelines, the acronym created by taking"},{"line_number":21,"context_line":"the first letters of the OpenStack book name.  *workflow-diagram.svg*"},{"line_number":22,"context_line":"provides a description of what the diagram is about, as well as the"},{"line_number":23,"context_line":"file type extension."},{"line_number":24,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_81e8d77d","line":21,"range":{"start_line":21,"start_character":47,"end_line":21,"end_character":69},"updated":"2016-06-29 10:03:13.000000000","message":"``workflow-diagram.svg``","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":25,"context_line":"Other file guidelines"},{"line_number":26,"context_line":"~~~~~~~~~~~~~~~~~~~~~"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":"* Files must be saved with a transparent background"},{"line_number":29,"context_line":"* Files must be saved in a \"landscape\" document style."},{"line_number":30,"context_line":"* Diagram width and height should be no more than 900px."}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_01fd073a","line":28,"range":{"start_line":28,"start_character":41,"end_line":28,"end_character":51},"updated":"2016-06-29 10:03:13.000000000","message":"background. *","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":26,"context_line":"~~~~~~~~~~~~~~~~~~~~~"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":"* Files must be saved with a transparent background"},{"line_number":29,"context_line":"* Files must be saved in a \"landscape\" document style."},{"line_number":30,"context_line":"* Diagram width and height should be no more than 900px."}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_819f3702","line":29,"range":{"start_line":29,"start_character":27,"end_line":29,"end_character":38},"updated":"2016-06-29 10:03:13.000000000","message":"remove the square quotes","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":1,"context_line":".. _dg_files:"},{"line_number":2,"context_line":""},{"line_number":3,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":4,"context_line":"Use recommended file format"},{"line_number":5,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"No matter which illustration tool you use, all diagrams files"}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_ecef9984","line":4,"updated":"2016-07-13 21:54:03.000000000","message":"File formats","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":5,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"No matter which illustration tool you use, all diagrams files"},{"line_number":8,"context_line":"must be saved as an editable ``.svg`` file."},{"line_number":9,"context_line":""},{"line_number":10,"context_line":"Furthermore, any outside stencils or objects added to a diagram"},{"line_number":11,"context_line":"should also be ``.svg`` files, so that reviewers can edit individual elements"}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_2fb23306","line":8,"updated":"2016-07-13 21:54:03.000000000","message":"Each diagram should include files in the following formats:\n\n* Raster, always Portable Network Graphics (PNG). The documentation build process uses these files.\n* Vector, typically Scalable Vector Graphics (SVG). Most illustration tools support editing these files.\n* Original, typically the native format of the tool.\n\nAt a minimum, each diagram must include a PNG and SVG file.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":10897,"name":"Joseph Robinson","email":"josephremail@gmail.com","username":"RobiJoe"},"change_message_id":"b634bba15a3c70963da7352498a4744e39d552a8","unresolved":false,"context_lines":[{"line_number":9,"context_line":""},{"line_number":10,"context_line":"Furthermore, any outside stencils or objects added to a diagram"},{"line_number":11,"context_line":"should also be ``.svg`` files, so that reviewers can edit individual elements"},{"line_number":12,"context_line":"of the diagram diagram."},{"line_number":13,"context_line":""},{"line_number":14,"context_line":"File names"},{"line_number":15,"context_line":"~~~~~~~~~~"}],"source_content_type":"text/x-rst","patch_set":5,"id":"3aaa91ec_91d8ef1f","line":12,"updated":"2016-06-30 07:39:56.000000000","message":"Double \u0027diagram\u0027 here.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":14643,"name":"Olga Gusarenko","email":"ogusarenko@mirantis.com","username":"Olga"},"change_message_id":"cf9e33a0077fbd9ba4a4bc3f128f656870125365","unresolved":false,"context_lines":[{"line_number":9,"context_line":""},{"line_number":10,"context_line":"Furthermore, any outside stencils or objects added to a diagram"},{"line_number":11,"context_line":"should also be ``.svg`` files, so that reviewers can edit individual elements"},{"line_number":12,"context_line":"of the diagram diagram."},{"line_number":13,"context_line":""},{"line_number":14,"context_line":"File names"},{"line_number":15,"context_line":"~~~~~~~~~~"}],"source_content_type":"text/x-rst","patch_set":5,"id":"3aaa91ec_6f38f4d3","line":12,"range":{"start_line":12,"start_character":15,"end_line":12,"end_character":22},"updated":"2016-06-30 11:39:27.000000000","message":"Though, Sphinx knows how to include SVG files in RST, it sometimes can handle/build them in a distorted way. The best practices for now are to include diagrams in some other format (apart from saving them in a repo as editable SVG files).\n\nAs we agreed during the Austin session, PNG is preferred (https://etherpad.openstack.org/p/austin-docs-contributorguide)\n\nSo, the user should provide/commit two formats of the same image: PNG (to enable Sphinx to build the output correctly) and SVG (to enable other contributors to edit the diagram).\n\nPS: You can see how this works on practice if you refer to the Networking guide sources, for example.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":9,"context_line":""},{"line_number":10,"context_line":"Furthermore, any outside stencils or objects added to a diagram"},{"line_number":11,"context_line":"should also be ``.svg`` files, so that reviewers can edit individual elements"},{"line_number":12,"context_line":"of the diagram diagram."},{"line_number":13,"context_line":""},{"line_number":14,"context_line":"File names"},{"line_number":15,"context_line":"~~~~~~~~~~"}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_b2496862","line":12,"range":{"start_line":12,"start_character":15,"end_line":12,"end_character":22},"in_reply_to":"3aaa91ec_6f38f4d3","updated":"2016-07-13 21:54:03.000000000","message":"I would love to see Sphinx convert SVG to PNG on the fly to achieve better rendering for HTML and use SVG directly if we decide to produce PDFs again (also a vector format). However, contrary to popular belief, SVG is a very \"loose\" standard that tends to cause rendering issues with tools other than the one that initially creates the file. We probably need to add this caveat for SVG files... perhaps a \"heads up\" that they don\u0027t always work 100%.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":16,"context_line":""},{"line_number":17,"context_line":"Contributors must create unique and meaningful file names to"},{"line_number":18,"context_line":"differentiate between diagrams. An example of this is the name"},{"line_number":19,"context_line":"``cg-workflow-digram.svg``. ``cg`` indicates that this diagram belongs"},{"line_number":20,"context_line":"in the contributor guidelines, the acronym created by taking"},{"line_number":21,"context_line":"the first letters of the OpenStack book name.  ``workflow-diagram.svg``"},{"line_number":22,"context_line":"provides a description of what the diagram is about, as well as the"}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_bc75b298","line":19,"updated":"2016-07-13 21:54:03.000000000","message":"Each \"book\" contains a figures directory, so I prefer to leave the book name out of the diagram file name (same with text files) to minimize length.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":10897,"name":"Joseph Robinson","email":"josephremail@gmail.com","username":"RobiJoe"},"change_message_id":"b634bba15a3c70963da7352498a4744e39d552a8","unresolved":false,"context_lines":[{"line_number":18,"context_line":"differentiate between diagrams. An example of this is the name"},{"line_number":19,"context_line":"``cg-workflow-digram.svg``. ``cg`` indicates that this diagram belongs"},{"line_number":20,"context_line":"in the contributor guidelines, the acronym created by taking"},{"line_number":21,"context_line":"the first letters of the OpenStack book name.  ``workflow-diagram.svg``"},{"line_number":22,"context_line":"provides a description of what the diagram is about, as well as the"},{"line_number":23,"context_line":"file type extension."},{"line_number":24,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"3aaa91ec_d1eef789","line":21,"updated":"2016-06-30 07:39:56.000000000","message":"Also, one suggestion here - add an \u0027And\u0027 to start the sentence.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":26,"context_line":"~~~~~~~~~~~~~~~~~~~~~"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":"* Files must be saved with a transparent background."},{"line_number":29,"context_line":"* Files must be saved in a landscape document style."},{"line_number":30,"context_line":"* Diagram width and height should be no more than 900px."}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_7c606acf","line":29,"updated":"2016-07-13 21:54:03.000000000","message":"Not necessarily... our documents render in portrait format.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":27,"context_line":""},{"line_number":28,"context_line":"* Files must be saved with a transparent background."},{"line_number":29,"context_line":"* Files must be saved in a landscape document style."},{"line_number":30,"context_line":"* Diagram width and height should be no more than 900px."}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_fc23ba55","line":30,"updated":"2016-07-13 21:54:03.000000000","message":"Pixels relate to screen resolution, not a quantifiable dimension. If anything, we should standardize on points... or run some experiments to see what works best with Sphinx.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":22314,"name":"Ryan Selden","email":"seldenr@icloud.com","username":"seldenr"},"change_message_id":"fd1f121b4f1296b1a913126421d1cdec67c3f867","unresolved":false,"context_lines":[{"line_number":9,"context_line":""},{"line_number":10,"context_line":"Furthermore, any outside stencils or objects added to a diagram"},{"line_number":11,"context_line":"should also be ``.svg`` files, so that reviewers can edit individual elements"},{"line_number":12,"context_line":"of the diagram diagram."},{"line_number":13,"context_line":""},{"line_number":14,"context_line":"File names"},{"line_number":15,"context_line":"~~~~~~~~~~"}],"source_content_type":"text/x-rst","patch_set":6,"id":"dada55a8_242add7e","line":12,"range":{"start_line":12,"start_character":7,"end_line":12,"end_character":22},"updated":"2016-07-19 22:42:32.000000000","message":"diagram","commit_id":"75eab31dfb39ceb249ca1478fa0a303aa9a48865"}],"doc/contributor-guide/source/diagram-guidelines/general-guidelines.rst":[{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":7,"context_line":"Text format"},{"line_number":8,"context_line":"~~~~~~~~~~~"},{"line_number":9,"context_line":""},{"line_number":10,"context_line":"* Set the font to *Helvetica*."},{"line_number":11,"context_line":"* Set the font size to at least 14px."},{"line_number":12,"context_line":"* All objects must be labeled with text."},{"line_number":13,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_81b61788","line":10,"range":{"start_line":10,"start_character":18,"end_line":10,"end_character":29},"updated":"2016-06-29 10:03:13.000000000","message":"Helvetica* is fine on its own :)","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":8,"context_line":"~~~~~~~~~~~"},{"line_number":9,"context_line":""},{"line_number":10,"context_line":"* Set the font to *Helvetica*."},{"line_number":11,"context_line":"* Set the font size to at least 14px."},{"line_number":12,"context_line":"* All objects must be labeled with text."},{"line_number":13,"context_line":""},{"line_number":14,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_211be381","line":11,"range":{"start_line":11,"start_character":23,"end_line":11,"end_character":36},"updated":"2016-06-29 10:03:13.000000000","message":"at least - being the smallest you suggest to use?","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":15,"context_line":"Objects"},{"line_number":16,"context_line":"~~~~~~~"},{"line_number":17,"context_line":""},{"line_number":18,"context_line":".. I would like more feedback on this aspect of the diagram guidelines."},{"line_number":19,"context_line":"   Currently, no project specific icons exist for OpenStack, and I"},{"line_number":20,"context_line":"   personally believe that they should. Having project specific icons"},{"line_number":21,"context_line":"   will allow for consistency across diagrams that would not otherwise"},{"line_number":22,"context_line":"   exist. We can also have icons for Zuul and Gerrit."},{"line_number":23,"context_line":""},{"line_number":24,"context_line":"Objects represent a concept or a function:"},{"line_number":25,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_44ff1d01","line":22,"range":{"start_line":18,"start_character":3,"end_line":22,"end_character":53},"updated":"2016-06-29 10:03:13.000000000","message":"Perhaps ask this question in the comments","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":33,"context_line":""},{"line_number":34,"context_line":"Any objects inside a diagram should be black, unless the object"},{"line_number":35,"context_line":"needs to be emphasized within a diagram in order to fully"},{"line_number":36,"context_line":"understand it\u0027s function. Colored objects may only use"},{"line_number":37,"context_line":"bright primary colors, such as light blue, red, or green. You can make"},{"line_number":38,"context_line":"multiple objects the same color, provided the objects serve"},{"line_number":39,"context_line":"similar functions or purposes."}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_c4130d5b","line":36,"range":{"start_line":36,"start_character":11,"end_line":36,"end_character":15},"updated":"2016-06-29 10:03:13.000000000","message":"its*","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":43,"context_line":"~~~~~"},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"Lines are used to connect and display a relationship between two"},{"line_number":46,"context_line":"or more objects:"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"Line shape"},{"line_number":49,"context_line":"----------"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_642339a8","line":46,"range":{"start_line":46,"start_character":8,"end_line":46,"end_character":16},"updated":"2016-06-29 10:03:13.000000000","message":"objects. *","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":14947,"name":"Maria Zlatkova","email":"mzlatkova@mirantis.com","username":"mzlatkova"},"change_message_id":"9a12c6cc46a0a36da50883a32a1f84ac41079b1d","unresolved":false,"context_lines":[{"line_number":69,"context_line":"Dotted lines"},{"line_number":70,"context_line":"------------"},{"line_number":71,"context_line":""},{"line_number":72,"context_line":"Use dotted lined to show how data entered by a human user travels."},{"line_number":73,"context_line":""},{"line_number":74,"context_line":""},{"line_number":75,"context_line":"Arrows"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_21b923cc","line":72,"range":{"start_line":72,"start_character":15,"end_line":72,"end_character":16},"updated":"2016-06-29 10:07:27.000000000","message":"lines","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":14947,"name":"Maria Zlatkova","email":"mzlatkova@mirantis.com","username":"mzlatkova"},"change_message_id":"9a12c6cc46a0a36da50883a32a1f84ac41079b1d","unresolved":false,"context_lines":[{"line_number":75,"context_line":"Arrows"},{"line_number":76,"context_line":"~~~~~~"},{"line_number":77,"context_line":""},{"line_number":78,"context_line":"Use arrows to represent one way interactions between two or more"},{"line_number":79,"context_line":"objects. If an object is attached to an arrow, it implies that the"},{"line_number":80,"context_line":"function represented by the object can only work when interacting"},{"line_number":81,"context_line":"with another object in the diagram."}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_213483f9","line":78,"range":{"start_line":78,"start_character":24,"end_line":78,"end_character":31},"updated":"2016-06-29 10:07:27.000000000","message":"one-way","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":1,"context_line":".. _dg_general:"},{"line_number":2,"context_line":""},{"line_number":3,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":4,"context_line":"Diagram general guidelines"},{"line_number":5,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"Text format"}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_8c709509","line":4,"updated":"2016-07-13 21:54:03.000000000","message":"You\u0027re already in a section about diagrams, so you could just call this \"guidelines\".","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":7,"context_line":"Text format"},{"line_number":8,"context_line":"~~~~~~~~~~~"},{"line_number":9,"context_line":""},{"line_number":10,"context_line":"* Set the font to Helvetica."},{"line_number":11,"context_line":"* Set the font size to above 14px."},{"line_number":12,"context_line":"* All objects must be labeled with text."},{"line_number":13,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_2caec180","line":10,"updated":"2016-07-13 21:54:03.000000000","message":"We render Open Sans, but some tools such as draw.io do not appear to support additional fonts.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":8,"context_line":"~~~~~~~~~~~"},{"line_number":9,"context_line":""},{"line_number":10,"context_line":"* Set the font to Helvetica."},{"line_number":11,"context_line":"* Set the font size to above 14px."},{"line_number":12,"context_line":"* All objects must be labeled with text."},{"line_number":13,"context_line":""},{"line_number":14,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_0c0dc58e","line":11,"updated":"2016-07-13 21:54:03.000000000","message":"Depends on the diagram content. We should suggest a size for the title and sub-title, but text within an object often depends on the size of the object. For example, most of the smaller objects in the networking guide diagrams use 6-8 pt.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":6772,"name":"Stephen Gordon","email":"sgordon@redhat.com","username":"sgordon"},"change_message_id":"8c54053437ef415b8150ba71a7331a43a11cd5f4","unresolved":false,"context_lines":[{"line_number":19,"context_line":"   Currently, no project specific icons exist for OpenStack, and I"},{"line_number":20,"context_line":"   personally believe that they should. Having project specific icons"},{"line_number":21,"context_line":"   will allow for consistency across diagrams that would not otherwise"},{"line_number":22,"context_line":"   exist. We can also have icons for Zuul and Gerrit."},{"line_number":23,"context_line":""},{"line_number":24,"context_line":"Objects represent a concept or a function:"},{"line_number":25,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"3aaa91ec_22b22f07","line":22,"updated":"2016-07-01 17:14:31.000000000","message":"Might be worth connecting with foundation marketing folks here, there are at least some icons that they have been consistently using for more well known projects.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":21,"context_line":"   will allow for consistency across diagrams that would not otherwise"},{"line_number":22,"context_line":"   exist. We can also have icons for Zuul and Gerrit."},{"line_number":23,"context_line":""},{"line_number":24,"context_line":"Objects represent a concept or a function:"},{"line_number":25,"context_line":""},{"line_number":26,"context_line":"* An object must be a closed geometric shape or icon."},{"line_number":27,"context_line":"* Objects must have a hollow middle, where text can be added."}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_4ca06d90","line":24,"updated":"2016-07-13 21:54:03.000000000","message":"People generally know the role of objects in a diagram.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":36,"context_line":"understand its function. Colored objects may only use"},{"line_number":37,"context_line":"bright primary colors, such as light blue, red, or green. You can make"},{"line_number":38,"context_line":"multiple objects the same color, provided the objects serve"},{"line_number":39,"context_line":"similar functions or purposes."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":""},{"line_number":42,"context_line":"Lines"}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_a5280998","line":39,"updated":"2016-07-13 21:54:03.000000000","message":"We tend to use the \"solarized\" color scheme because it provides a variety of pleasing but specific colors.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":43,"context_line":"~~~~~"},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"Lines are used to connect and display a relationship between two"},{"line_number":46,"context_line":"or more objects."},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"Line shape"},{"line_number":49,"context_line":"----------"}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_291eb35e","line":46,"updated":"2016-07-13 21:54:03.000000000","message":"People generally know the role of lines in a diagram, but they don\u0027t know attributes such as color and width, how to address crossing issues, etc.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":50,"context_line":""},{"line_number":51,"context_line":"Keep lines straight unless a line needs to change direction. If"},{"line_number":52,"context_line":"a line changes direction to reach an object, the corner in"},{"line_number":53,"context_line":"which the change of direction occurs must be rounded."},{"line_number":54,"context_line":""},{"line_number":55,"context_line":"Solid lines"},{"line_number":56,"context_line":"-----------"}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_29f19301","line":53,"updated":"2016-07-13 21:54:03.000000000","message":"A line should also avoid crossing an object, specifically if obscuring text in it.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":52,"context_line":"a line changes direction to reach an object, the corner in"},{"line_number":53,"context_line":"which the change of direction occurs must be rounded."},{"line_number":54,"context_line":""},{"line_number":55,"context_line":"Solid lines"},{"line_number":56,"context_line":"-----------"},{"line_number":57,"context_line":""},{"line_number":58,"context_line":"Use solid lines to show a direct relationship between objects."}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_ec895927","line":55,"updated":"2016-07-13 21:54:03.000000000","message":"Beyond width, I have a tough time with specifying/limiting use of line style. Sort of depends on the diagram, specifically the complexity. I prefer making suggestions/recommendations using existing diagrams (or specific snippets) as examples.  Also, please avoid use of project code-names.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":78,"context_line":"Use arrows to represent one-way interactions between two or more"},{"line_number":79,"context_line":"objects. If an object is attached to an arrow, it implies that the"},{"line_number":80,"context_line":"function represented by the object can only work when interacting"},{"line_number":81,"context_line":"with another object in the diagram."}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_4cd86def","line":81,"updated":"2016-07-13 21:54:03.000000000","message":"Mostly makes sense. However, do we want to suggest arrow head type(s)?","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"}],"doc/contributor-guide/source/diagram-guidelines/tools.rst":[{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":4,"context_line":"Tools"},{"line_number":5,"context_line":"\u003d\u003d\u003d\u003d\u003d"},{"line_number":6,"context_line":""},{"line_number":7,"context_line":"There are many diagramming tools, and contributors are free"},{"line_number":8,"context_line":"to use the illustrator of their choice."},{"line_number":9,"context_line":""},{"line_number":10,"context_line":"However, elements within a diagram must be easily edited or"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_c4414d3b","line":7,"range":{"start_line":7,"start_character":15,"end_line":7,"end_character":32},"updated":"2016-06-29 10:03:13.000000000","message":"tools you can use to create a diagram*","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":14947,"name":"Maria Zlatkova","email":"mzlatkova@mirantis.com","username":"mzlatkova"},"change_message_id":"9a12c6cc46a0a36da50883a32a1f84ac41079b1d","unresolved":false,"context_lines":[{"line_number":15,"context_line":""},{"line_number":16,"context_line":"Open source tools can help streamline the review process by making"},{"line_number":17,"context_line":"diagrams easy to edit. Many open-source tools contain shapes and"},{"line_number":18,"context_line":"stencils that can be used in Openstack. Following is a list of"},{"line_number":19,"context_line":"recommended open source tools:"},{"line_number":20,"context_line":""},{"line_number":21,"context_line":"* `Draw.io\u003chttps://www.draw.io/\u003e_`: Draw.io contains all the"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_8420e59c","line":18,"range":{"start_line":18,"start_character":40,"end_line":18,"end_character":49},"updated":"2016-06-29 10:07:27.000000000","message":"The following","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":20,"context_line":""},{"line_number":21,"context_line":"* `Draw.io\u003chttps://www.draw.io/\u003e_`: Draw.io contains all the"},{"line_number":22,"context_line":"  customization options needed to make diagrams. Diagrams can also"},{"line_number":23,"context_line":"  be saved as an .svg file, which allows contributors to edit individual"},{"line_number":24,"context_line":"  elements of each diagram."},{"line_number":25,"context_line":""},{"line_number":26,"context_line":".. I have left this space for other contributors to recommend"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_449b9dc9","line":23,"range":{"start_line":23,"start_character":17,"end_line":23,"end_character":21},"updated":"2016-06-29 10:03:13.000000000","message":"``.svg``","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"78c0691a5a231dae501268e1e636f5995397cfab","unresolved":false,"context_lines":[{"line_number":23,"context_line":"  be saved as an .svg file, which allows contributors to edit individual"},{"line_number":24,"context_line":"  elements of each diagram."},{"line_number":25,"context_line":""},{"line_number":26,"context_line":".. I have left this space for other contributors to recommend"},{"line_number":27,"context_line":"   any other open source diagram tools."}],"source_content_type":"text/x-rst","patch_set":2,"id":"3aaa91ec_04ba3523","line":27,"range":{"start_line":26,"start_character":0,"end_line":27,"end_character":39},"updated":"2016-06-29 10:03:13.000000000","message":"Ask the question in the comments too","commit_id":"f37022f78cc6382d09405487e67ea9ac81e35a89"},{"author":{"_account_id":21152,"name":"zhang.xiuhua","email":"zhang.xiuhua@99cloud.net","username":"zhang.xiuhua"},"change_message_id":"6f5739a67e36b5bd159ea78ff1ce37336a7a7068","unresolved":false,"context_lines":[{"line_number":15,"context_line":""},{"line_number":16,"context_line":"Open source tools can help streamline the review process by making"},{"line_number":17,"context_line":"diagrams easy to edit. Many open-source tools contain shapes and"},{"line_number":18,"context_line":"stencils that can be used in Openstack. The following is a list"},{"line_number":19,"context_line":"recommended open source tools:"},{"line_number":20,"context_line":""},{"line_number":21,"context_line":"* `Draw.io\u003chttps://www.draw.io/\u003e_`: Draw.io contains all the"}],"source_content_type":"text/x-rst","patch_set":5,"id":"3aaa91ec_815c1a4c","line":18,"range":{"start_line":18,"start_character":29,"end_line":18,"end_character":38},"updated":"2016-06-30 10:06:03.000000000","message":"Should be \u0027OpenStack\u0027","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"401103c4ff5c1f50c58f8e79fb97fa758b0159e4","unresolved":false,"context_lines":[{"line_number":19,"context_line":"recommended open source tools:"},{"line_number":20,"context_line":""},{"line_number":21,"context_line":"* `Draw.io\u003chttps://www.draw.io/\u003e_`: Draw.io contains all the"},{"line_number":22,"context_line":"  customization options needed to make diagrams. Diagrams can also"},{"line_number":23,"context_line":"  be saved as an ``.svg`` file, which allows contributors to edit"},{"line_number":24,"context_line":"  individual elements of each diagram."},{"line_number":25,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"1aa78d24_433ae135","line":22,"updated":"2016-07-13 21:54:03.000000000","message":"I wouldn\u0027t say all, but it does enable creation of more visually pleasing diagrams than most open source tools.","commit_id":"450620a7ec5104fb9d9126eb73273f9b6bce8e21"},{"author":{"_account_id":10497,"name":"KATO Tomoyuki","email":"kato.tomoyuki@jp.fujitsu.com","username":"to222"},"change_message_id":"696ee5413710a2a322f859416012dec9b7a34e3e","unresolved":false,"context_lines":[{"line_number":18,"context_line":"stencils that can be used in Openstack. The following is a list"},{"line_number":19,"context_line":"recommended open source tools:"},{"line_number":20,"context_line":""},{"line_number":21,"context_line":"* `Draw.io\u003chttps://www.draw.io/\u003e_`: Draw.io contains all the"},{"line_number":22,"context_line":"  customization options needed to make diagrams. Diagrams can also"},{"line_number":23,"context_line":"  be saved as an ``.svg`` file, which allows contributors to edit"},{"line_number":24,"context_line":"  individual elements of each diagram."}],"source_content_type":"text/x-rst","patch_set":10,"id":"dada55a8_fe80cef8","line":21,"range":{"start_line":21,"start_character":2,"end_line":21,"end_character":34},"updated":"2016-07-22 05:28:52.000000000","message":"`Draw.io\u003chttps://www.draw.io/\u003e`_","commit_id":"fa295772b09de69e0ac71dee343571a43fba819a"}],"doc/contributor-guide/source/index.rst":[{"author":{"_account_id":10497,"name":"KATO Tomoyuki","email":"kato.tomoyuki@jp.fujitsu.com","username":"to222"},"change_message_id":"817f1a6617781d8b2cca166b249e7f1987cb391f","unresolved":false,"context_lines":[{"line_number":30,"context_line":"   ui-text-guidelines.rst"},{"line_number":31,"context_line":"   rst-conv.rst"},{"line_number":32,"context_line":"   json-conv.rst"},{"line_number":33,"context_line":"   diagram-guidelines.rst"},{"line_number":34,"context_line":"   docs-builds.rst"},{"line_number":35,"context_line":"   doc-tools.rst"},{"line_number":36,"context_line":""}],"source_content_type":"text/x-rst","patch_set":10,"id":"dada55a8_e9995f7a","line":33,"updated":"2016-07-21 13:06:09.000000000","message":"I\u0027d like to add this after ui-text-guidelines because this is not only for documentation as same as UI/UX.","commit_id":"fa295772b09de69e0ac71dee343571a43fba819a"}]}