You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+30Lines changed: 30 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,3 +13,33 @@ Describe the overall goals of this pull request.
13
13
14
14
* old xml:id...
15
15
* old URL...
16
+
17
+
### Check the articles's configuration
18
+
* Make sure that all references and parameters are properly set in the DC file:
19
+
-[ ] Check the DC file name (hypenated, human-readable): *`TOPIC[-SUBTOPIC]-TITLE`*. Once set and published, this **must not ever** be changed again once the article is published.
20
+
-[ ] Set profiling attributes, if necessary.
21
+
* Make sure the article's root ID in the `*.asm.xml` file matches the one provided in the DC file. **Do not ever** change this ID again once the article is published.
22
+
23
+
### Check the article's metadata
24
+
-[ ] Is `dm:maintainer` for Bugzilla tickets set (add your e-mail address)?
25
+
-[ ] Is `dm:translation` set (`yes`/`no`)?
26
+
-[ ] Is the `maintainer` meta tag set (on assembly and topics)?
27
+
-[ ] Are `title` and `meta title` set? `title` determines the title that's displayed in PDF/HTML. `meta title` is used for search engines and social media and should not exceed *55 characters*.
28
+
-[ ] Are `description` and `social-descr` set? `description` is displayed on search engine results pages and should not exceed *150 characters*. `social-descr` is are displayed when the article is shared via social media and shout not exceed *55 characters*.
29
+
-[ ] Is `series` set? This tag determines which type of documentation your article belongs to. *not supported yet, more info to come*.
30
+
-[ ] Is `productname` set to the respective product name(s) and version(s)? Use the approved product acronym. *Do not use entities*.
31
+
-[ ] Is
32
+
-[ ] ... type
33
+
34
+
### Maintain the revision history
35
+
Check the [SUSE Documentation Style Guide](https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-revhistory) for detailed instructions on how to maintain a revision history for your document.
36
+
-[ ] Create a meaningful `revdescription` entry.
37
+
-[ ] Set the revision history date to the date of your merge commit. The date format has to be *YYYY-MM-DD*.
0 commit comments