|
| 1 | +# Release Notes Guidelines |
| 2 | + |
| 3 | +This section contains guidelines on naming files, sections and other document elements. |
| 4 | + |
| 5 | +> **If there is no changes in product, you don't need to mention that in Release Notes.** |
| 6 | +
|
| 7 | +## Encoding Format |
| 8 | + |
| 9 | +All Release Notes files should be saved in **Encoding in UTF-8 (Without BOM)** format. You can use Notepad++ to verify the encoding. |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +## Release Notes Folder Hierarchy |
| 14 | + |
| 15 | +* Platform [Folder] |
| 16 | +* ----ReleaseNotes [Folder] |
| 17 | +* --------v13.3.x.x [Folder] |
| 18 | +* ------------Control1.md |
| 19 | +* ------------Control2.md |
| 20 | +* ------------Control3.md |
| 21 | +* --------v13.4.x.x [Folder] |
| 22 | +* ------------Control1.md |
| 23 | +* ------------Control2.md |
| 24 | +* ------------Control3.md |
| 25 | + |
| 26 | +### How to write Release Notes? |
| 27 | + |
| 28 | +* Each release markdown files should reside under corresponding version folder in their platform. |
| 29 | +* Each product release notes should be created in separate file name. |
| 30 | +* File name should be same as the product name. |
| 31 | + |
| 32 | +> **NOTE**: Please do not add any Front Matter information in Release Notes files. |
| 33 | +
|
| 34 | +## Markdown File Structure |
| 35 | + |
| 36 | +Each markdown file should have following items. |
| 37 | + |
| 38 | +* Control Name |
| 39 | +* Features |
| 40 | +* Bug fixes |
| 41 | +* Braking Changes |
| 42 | +* Known Issues |
| 43 | + |
| 44 | +> Do not add any front matter(triple dashed line) in this markdown. |
| 45 | +
|
| 46 | +### Control Name |
| 47 | + |
| 48 | +Control Name should be with prefix `##`. This will be rendered as `H2` in html file. |
| 49 | + |
| 50 | +#### Syntax |
| 51 | + |
| 52 | +``` |
| 53 | +## <Control-Name> |
| 54 | +``` |
| 55 | + |
| 56 | +#### Example |
| 57 | + |
| 58 | +``` |
| 59 | +## ejAccrodion |
| 60 | +``` |
| 61 | + |
| 62 | +### Features |
| 63 | + |
| 64 | +* Each features should be written in unordered list. |
| 65 | +* Feature header should have id in the following format `<control-name>-features`. All characters in **id should be written in lower case.** |
| 66 | + |
| 67 | +#### Syntax |
| 68 | + |
| 69 | +``` |
| 70 | +### Features |
| 71 | +{:#<control-name>-features} |
| 72 | +
|
| 73 | +* \#1 - Feature Info |
| 74 | +* \#2 - Feature Info |
| 75 | +* \#3 - Feature Info |
| 76 | +``` |
| 77 | + |
| 78 | +#### Example |
| 79 | + |
| 80 | +``` |
| 81 | +### Features |
| 82 | +{:#ejaccordion-features} |
| 83 | +
|
| 84 | +* \#140303 - Accordion provides option to add new items dynamically by using the `addItem` method |
| 85 | +* \#140303 - Accordion provides option to add new items dynamically by using the `addItem` method |
| 86 | +* \#140303, \#140304 - Accordion provides option to add new items dynamically by using the `addItem` method |
| 87 | +``` |
| 88 | + |
| 89 | +> **NOTE:** |
| 90 | +> * In markdown `#` used to represent headers. |
| 91 | +> * By default it will be converted as HTML headers. |
| 92 | +> * To display the `#` in html, please use escape sequences [See above example]. |
| 93 | +
|
| 94 | +### Bug Fixes |
| 95 | + |
| 96 | +* Each bug fix should be written in unordered list. |
| 97 | +* Bug fixes header should have id in the following format `<control-name>-bug-fixes`. All characters in **id should be written in lower case.** |
| 98 | + |
| 99 | +#### Syntax |
| 100 | + |
| 101 | +``` |
| 102 | +### Bug fixes |
| 103 | +{:#<control-name-in-lower-case>-bug-fixes} |
| 104 | +
|
| 105 | +* \#1 - Bug Fix |
| 106 | +* \#2 - Bug Fix |
| 107 | +* \#3 - Bug Fix |
| 108 | +``` |
| 109 | + |
| 110 | +#### Example |
| 111 | + |
| 112 | +``` |
| 113 | +### Bug Fixes |
| 114 | +{:#ejaccordion-bug-fixes} |
| 115 | +
|
| 116 | +* \#140303 - Accordion provides option to add new items dynamically by using the `addItem` method |
| 117 | +* \#140303 - Accordion provides option to add new items dynamically by using the `addItem` method |
| 118 | +* \#140303, \#140304 - Accordion provides option to add new items dynamically by using the `addItem` method |
| 119 | +``` |
| 120 | + |
| 121 | +> **NOTE:** |
| 122 | +> * In markdown `#` used to represent headers. |
| 123 | +> * By default it will be converted as HTML headers. |
| 124 | +> * To display the `#` in html, please use escape sequences [See above example]. |
| 125 | +
|
| 126 | +### Breaking Changes |
| 127 | + |
| 128 | +* Each breaking changes should be written in unordered list. |
| 129 | +* Breaking changes header should have id in the following format `<control-name>-breaking-changes`. All characters in **id should be written in lower case.** |
| 130 | + |
| 131 | +``` |
| 132 | +### Breaking Changes |
| 133 | +{:#<control-name>-breaking-changes} |
| 134 | +
|
| 135 | +* * Breaking Change 1 |
| 136 | +* * Breaking Change 2 |
| 137 | +* * Breaking Change 3 |
| 138 | +``` |
| 139 | + |
| 140 | +#### Example |
| 141 | + |
| 142 | +``` |
| 143 | +### Breaking Changes |
| 144 | +{:#ejaccordion-breaking-changes} |
| 145 | +
|
| 146 | +* Now, Circular series end angle will not be adjusted based on the start angle, so the output will be like semi-circle instead of full circle. In order to render the complete circular series with customized start angle, you have to add the start angle value to end angle property now. This break will occur only if you have specified startAngle already |
| 147 | +``` |
| 148 | + |
| 149 | +> **NOTE:** |
| 150 | +> * In markdown `#` used to represent headers. |
| 151 | +> * By default it will be converted as HTML headers. |
| 152 | +> * To display the `#` in html, please use escape sequences [See above example]. |
| 153 | +
|
| 154 | +## Incidents and Forums in Release notes |
| 155 | + |
| 156 | +We can represent the Incident ID with I and F for forums in release notes MD files |
| 157 | + |
| 158 | +#### Example |
| 159 | + |
| 160 | + |
| 161 | +``` |
| 162 | +## ChromelessWindow |
| 163 | +
|
| 164 | +### Bug Fixes |
| 165 | +{:#chromelesswindow-bug-fixes} |
| 166 | +
|
| 167 | +* \#I336220 - When using `ShowDialog` on a `RibbonWindow`, a `NullReferenceException` will no longer occur. |
| 168 | +* \#F166385 - The gap between the bottom of the window and the `TaskBar` is now properly maintained. |
| 169 | +
|
| 170 | +``` |
| 171 | + |
| 172 | +This is published in the page : https://help.syncfusion.com/wpf/release-notes/v19.3.0.43?type=all#chromelesswindow |
| 173 | + |
| 174 | + |
| 175 | +## Commit |
| 176 | + |
| 177 | +Same workflow for User Guide applicable to this repository. All the changes needs to be committed in `development` branch. |
| 178 | + |
| 179 | +## Preview Changes |
| 180 | + |
| 181 | +All the changes will be included with User Guide automation and published in Staging Documentation machine. |
| 182 | + |
| 183 | +<http://115.249.201.211:9090> |
0 commit comments