suse/doc-styleguide issues and pull requests

#313 - [doc] Issue in "Inline elements"

Issue - State: open - Opened by jfaltenbacher 4 days ago

#312 - Ban "headless" tables

Issue - State: open - Opened by janajaeger 25 days ago

#311 - Discourage use of informalfigure

Issue - State: open - Opened by janajaeger 25 days ago - 3 comments

#310 - Add a new section focused on accessibility

Issue - State: open - Opened by janajaeger 25 days ago

#309 - Added rule on colons

Pull Request - State: closed - Opened by dariavladykina 26 days ago - 1 comment

#308 - Deprecate Xend

Issue - State: open - Opened by dariavladykina about 1 month ago
Labels: section-terminology

#307 - Expanding the Style Guide to support ADoc

Issue - State: open - Opened by tomschr 2 months ago
Labels: type-enhancement, affects-docbook, affects-asciidoc

#306 - do not use <link> element for example links

Issue - State: open - Opened by dariavladykina 2 months ago - 2 comments

#305 - Updated revhistory example per new template

Pull Request - State: closed - Opened by dariavladykina 5 months ago - 1 comment

#304 - readahead/read-ahead/read ahead?

Issue - State: closed - Opened by dariavladykina 5 months ago - 1 comment

#303 - read/write or read-write?

Issue - State: closed - Opened by dariavladykina 5 months ago - 2 comments

#302 - hugepage or huge page?

Issue - State: closed - Opened by dariavladykina 5 months ago - 2 comments

#301 - Added punctuation specification for slashes

Pull Request - State: closed - Opened by dariavladykina 6 months ago

#300 - Updated word limit to 25 words #299

Pull Request - State: closed - Opened by dariavladykina 7 months ago

#299 - Increasing the Word Limit for Sentences

Issue - State: closed - Opened by alexvonme 8 months ago - 6 comments

#298 - Added instruction on when to use the guimenu tag

Pull Request - State: closed - Opened by dariavladykina 8 months ago

#297 - Turned style guide into book

Pull Request - State: closed - Opened by dariavladykina 9 months ago - 2 comments

#296 - Add section about the task element #233

Pull Request - State: open - Opened by dariavladykina 9 months ago - 5 comments

#295 - 'Technology Preview' vs. 'Technical Preview'

Issue - State: closed - Opened by cwickert 9 months ago - 5 comments

#294 - Update Language and Terminology sections with TermWeb

Pull Request - State: closed - Opened by dariavladykina 9 months ago - 4 comments

#293 - Update of the Prompts section

Pull Request - State: closed - Opened by dariavladykina 11 months ago

#292 - Update the entry order in Revhistory section #289

Pull Request - State: closed - Opened by dariavladykina 11 months ago

#291 - Update of the Entities section #285

Pull Request - State: closed - Opened by dariavladykina 11 months ago

#290 - Suggest a structure for WHAT? WHY? EFFORT etc. items in Smart Docs

Issue - State: closed - Opened by dariavladykina 12 months ago - 2 comments
Labels: type-question

#289 - Mention how to order revisions inside revhistory

Issue - State: closed - Opened by tomschr 12 months ago

#288 - Update section on identifiers #257

Pull Request - State: closed - Opened by dariavladykina about 1 year ago - 1 comment

#287 - Update guidance on trademark use #145

Pull Request - State: closed - Opened by dariavladykina about 1 year ago
Labels: section-language

#286 - Add a section for conscious language

Issue - State: closed - Opened by Amrita42 about 1 year ago - 8 comments

#285 - Section "Entities" should also mention generic-entities.ent

Issue - State: closed - Opened by tomschr about 1 year ago - 1 comment

#284 - Mention and explain the 'xrefstyle' attribute (#130)

Pull Request - State: closed - Opened by cwickert about 1 year ago
Labels: section-structure, affects-docbook

#283 - Update Structure chapter with links to doc-kit examples

Pull Request - State: closed - Opened by dariavladykina about 1 year ago

#282 - [doc] Issue in "Language"

Issue - State: closed - Opened by taroth21 about 1 year ago - 2 comments
Labels: via-report-link

#281 - Update file names and figures sections with naming conventions #143

Pull Request - State: closed - Opened by dariavladykina about 1 year ago

#280 - Update section on example items #136

Pull Request - State: closed - Opened by dariavladykina about 1 year ago

#279 - Added section on profiling #274

Pull Request - State: closed - Opened by dariavladykina about 1 year ago - 2 comments

#278 - Slight overhaul of the revhistory section

Pull Request - State: closed - Opened by janajaeger about 1 year ago

#277 - Correct revhistory example

Pull Request - State: closed - Opened by tomschr over 1 year ago

#276 - Add programlisting to taglist #275

Pull Request - State: closed - Opened by dariavladykina over 1 year ago

#275 - add 'programmlisting' to list of docbooktags

Issue - State: closed - Opened by jfaltenbacher over 1 year ago - 1 comment

#274 - Add a section about profiling?

Issue - State: closed - Opened by tomschr over 1 year ago - 1 comment

#273 - Added section on revhistory to Smart Docs

Pull Request - State: closed - Opened by dariavladykina over 1 year ago

#272 - Additional info about glossary tags

Pull Request - State: closed - Opened by dariavladykina over 1 year ago - 1 comment

#271 - Add correct glossary example

Pull Request - State: closed - Opened by dariavladykina over 1 year ago

#270 - Improve glossary section and example with <glossseealso/> and <glosssee/>

Issue - State: closed - Opened by tomschr over 1 year ago - 3 comments

#269 - Update Outline and Structure sections about glossaries

Pull Request - State: closed - Opened by dariavladykina over 1 year ago

#268 - Use revhistory, consolidate to one style guide

Pull Request - State: closed - Opened by tomschr over 1 year ago

#267 - Fix broken links found by ContentKing

Pull Request - State: closed - Opened by tomschr over 1 year ago
Labels: type-bug

#266 - Update style guide meta info

Pull Request - State: closed - Opened by dariavladykina over 1 year ago
Labels: type-enhancement

#265 - Update the use of citetitle and xref elements

Pull Request - State: closed - Opened by dariavladykina over 1 year ago

#264 - Updated AsciiDoc section title

Pull Request - State: closed - Opened by dariavladykina over 1 year ago

#262 - Added timeout to terminology #252

Pull Request - State: closed - Opened by dariavladykina over 1 year ago

#260 - Updated the Language chapter with info on product names

Pull Request - State: closed - Opened by dariavladykina over 1 year ago
Labels: section-language

#259 - Updated the AsciiDoc chapter and added link to TRD

Pull Request - State: closed - Opened by dariavladykina over 1 year ago
Labels: type-enhancement

#257 - Add section about ID/IDREF values and our conventions

Issue - State: closed - Opened by tomschr over 1 year ago - 6 comments
Labels: affects-docbook

#256 - Remove tags and inline elements that are not used/needed

Issue - State: closed - Opened by dariavladykina over 1 year ago - 1 comment

#254 - Screenshots with meaningful data?

Issue - State: closed - Opened by cwickert over 1 year ago - 2 comments
Labels: section-structure

#249 - Update info on the usage of formalpara #113

Pull Request - State: closed - Opened by dariavladykina over 1 year ago - 1 comment

#246 - Product names - their spelling and no article before

Issue - State: closed - Opened by dariavladykina almost 2 years ago - 4 comments

#240 - data is or data are?

Issue - State: closed - Opened by dariavladykina almost 2 years ago

#233 - Implement task element?

Issue - State: open - Opened by dariavladykina about 2 years ago - 7 comments

#228 - Date and Time - ISO 8601

Issue - State: closed - Opened by keichwa over 2 years ago - 8 comments

#224 - Terminology: Clarify that 'init script' should not be used for systemd

Pull Request - State: closed - Opened by cwickert over 2 years ago

#207 - File system names

Issue - State: closed - Opened by cwickert over 2 years ago - 7 comments
Labels: section-terminology

#204 - A new section about creating SP-independent links

Pull Request - State: closed - Opened by dariavladykina almost 3 years ago
Labels: section-structure

#180 - Mention titlecaseconverter?

Issue - State: closed - Opened by tomschr over 3 years ago - 2 comments
Labels: type-enhancement, section-language

#177 - A definition of what's worthy of inclusion in docs

Issue - State: closed - Opened by ghost over 3 years ago - 1 comment
Labels: type-enhancement, section-intro

#174 - Guidelines about when placeholders should be generics (`SOURCE`) v/ real-looking items (`/path/to/source.file`)

Issue - State: closed - Opened by ghost over 3 years ago - 6 comments
Labels: type-question, section-structure, section-example-names

#172 - Revise sudo recommendation

Issue - State: closed - Opened by cwickert over 3 years ago - 4 comments
Labels: section-structure

#167 - Tag version specific images

Issue - State: closed - Opened by cwickert almost 4 years ago - 7 comments
Labels: type-enhancement, section-structure

#160 - Do not use the term 'best effort'

Issue - State: closed - Opened by cwickert almost 4 years ago - 8 comments
Labels: section-terminology

#158 - Example user names

Issue - State: closed - Opened by cwickert about 4 years ago - 6 comments
Labels: section-example-names

#145 - Can we simplify the trademark guidance?

Issue - State: closed - Opened by ghost about 4 years ago - 8 comments
Labels: section-language

#143 - Standardize file names of images

Issue - State: closed - Opened by ghost over 4 years ago - 2 comments
Labels: type-enhancement, section-structure

#136 - Names of Example Items section should reference doc-kit-shipped entities

Issue - State: closed - Opened by taroth21 over 4 years ago - 2 comments
Labels: type-enhancement, section-example-names, via-report-link

#135 - Move DocBook Markup section to an appendix instead of including it in the Structure section

Issue - State: closed - Opened by taroth21 over 4 years ago - 2 comments
Labels: type-bug, section-structure, via-report-link, affects-asciidoc

#134 - Style Guide is very DocBook-centric

Issue - State: closed - Opened by taroth21 over 4 years ago - 2 comments
Labels: type-bug, via-report-link, affects-asciidoc

#130 - Define xrefstyle attribute usage guidelines

Issue - State: closed - Opened by ghost over 4 years ago - 6 comments
Labels: type-enhancement, section-structure

#118 - Access permissions v/ access rights..?

Issue - State: closed - Opened by ghost almost 5 years ago - 3 comments
Labels: section-terminology

#113 - Explain similarities between variablelists and formalparas within a list

Issue - State: closed - Opened by ghost almost 5 years ago - 9 comments
Labels: section-structure

#107 - Add some of the => some

Issue - State: closed - Opened by ghost almost 5 years ago - 2 comments
Labels: section-terminology

#103 - Add "web UI"?

Issue - State: closed - Opened by ghost almost 5 years ago - 1 comment
Labels: section-terminology

#100 - add match case/ignore case as rejected terms for case-sensitive/case-insensitive?

Issue - State: closed - Opened by ghost almost 5 years ago - 1 comment
Labels: resolution-wontfix, section-terminology

#99 - passphrase/keyword/password/passcode

Issue - State: closed - Opened by ghost almost 5 years ago - 3 comments
Labels: section-terminology

#98 - Company-wide Terminology Database

Issue - State: closed - Opened by ghost almost 5 years ago - 1 comment
Labels: type-enhancement, section-terminology

#97 - add kernel to terminology?

Issue - State: closed - Opened by ghost almost 5 years ago - 3 comments
Labels: section-terminology

#96 - Try to find a different program to recommend rather than Shutter

Issue - State: closed - Opened by ghost almost 5 years ago - 1 comment
Labels: section-structure

#95 - Add official list of acronyms to style guide

Issue - State: closed - Opened by ghost almost 5 years ago - 4 comments
Labels: type-bug, section-terminology

#94 - Document documentation.suse.com URL & how to link there

Issue - State: closed - Opened by tomschr about 5 years ago - 6 comments
Labels: type-enhancement, section-structure

#93 - Update Guidance on IDs

Pull Request - State: closed - Opened by ghost over 5 years ago

#92 - Add default 'width' attributes for screenshots

Pull Request - State: closed - Opened by cwickert almost 6 years ago

#91 - Use/omit the article when using xref or citetitle to reference other guides?

Issue - State: closed - Opened by ghost almost 6 years ago - 2 comments
Labels: type-enhancement, section-structure

#90 - Feature/avoid version numbers and dates

Pull Request - State: closed - Opened by cwickert almost 6 years ago

#89 - Avoid version numbers and dates in Screenshots

Issue - State: closed - Opened by cwickert almost 6 years ago
Labels: via-report-link, fixed

#88 - Mention that placeholders should be capitalized (#87)

Pull Request - State: closed - Opened by cwickert almost 6 years ago - 1 comment

#87 - [doc] 5.4.3 Placeholders should be capitalized

Issue - State: closed - Opened by cwickert almost 6 years ago
Labels: via-report-link

#86 - Which tag to use for subcommands?

Issue - State: closed - Opened by ghost over 6 years ago - 4 comments
Labels: section-structure, fixed

#85 - back-end should be backend

Issue - State: closed - Opened by dmpop over 6 years ago - 8 comments

#84 - Define para as the first element of every step

Issue - State: closed - Opened by tomschr over 6 years ago - 1 comment
Labels: type-enhancement, section-structure, fixed

#84 - Define para as the first element of every step

Issue - State: closed - Opened by tomschr over 6 years ago - 1 comment
Labels: type-enhancement, section-structure, fixed

#83 - Improve Callout section with <xref/>

Issue - State: closed - Opened by tomschr over 6 years ago - 1 comment
Labels: type-enhancement, section-structure

GitHub / suse/doc-styleguide issues and pull requests