Skip to content

Commit 8c4a078

Browse files
committed
Enforce markdownlint rules MD022,MD031,MD032
- MD022/blanks-around-headings Headings should be surrounded by blank lines - MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines - MD032/blanks-around-lists Lists should be surrounded by blank lines Run the tool locally with the `--fix` argument to autofix the Markdown. https://github.com/DavidAnson/markdownlint?tab=readme-ov-file#rules--aliases
1 parent 0526ec0 commit 8c4a078

File tree

23 files changed

+189
-9
lines changed

23 files changed

+189
-9
lines changed

.github/linters/.markdown-lint.yml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,6 @@ MD013: false
3636
# MD014/commands-show-output Dollar signs used before commands without showing output
3737
MD014: false
3838

39-
# MD022/blanks-around-headings Headings should be surrounded by blank lines
40-
MD022: false
41-
4239
# MD023/heading-start-left Headings must start at the beginning of the line
4340
MD023: false
4441

@@ -57,12 +54,6 @@ MD028: false
5754
# MD029/ol-prefix Ordered list item prefix
5855
MD029: false
5956

60-
# MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines
61-
MD031: false
62-
63-
# MD032/blanks-around-lists Lists should be surrounded by blank lines
64-
MD032: false
65-
6657
# MD033/no-inline-html Inline HTML
6758
MD033: false
6859

CHANGES.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -648,6 +648,7 @@ Release notes contain the list of [bug fixes](http://cloudstack.apache.org/docs/
648648

649649
Version 4.2.0
650650
-------------
651+
651652
Released on October 1 2013.
652653
Release notes contain the list of [bug fixes](http://cloudstack.apache.org/docs/en-US/Apache_CloudStack/4.2.0/html/Release_Notes/index.html)
653654

@@ -662,6 +663,7 @@ Build Tool Changes:
662663
* The project now uses Maven 3 exclusively to build.
663664

664665
New Features:
666+
665667
* CLOUDSTACK-101: OVS support in KVM
666668
* CLOUDSTACK-132: Mash up marvin into an interactive auto-completing API shell for CloudStack
667669
* CLOUDSTACK-241: AWS Style Regions

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ Contributing to Apache CloudStack (ACS)
33

44
Summary
55
-------
6+
67
This document covers how to contribute to the ACS project. ACS uses GitHub PRs to manage code contributions.
78
These instructions assume you have a GitHub.com account, so if you don't have one you will have to create one. Your proposed code changes will be published to your own fork of the ACS project, and you will submit a Pull Request for your changes to be added.
89

@@ -26,6 +27,7 @@ No back porting / cherry-picking features to existing branches!
2627

2728
PendingReleaseNotes file
2829
------------------------
30+
2931
When developing a new feature or making a (major) change to an existing feature you are encouraged to append this to the PendingReleaseNotes file so that the Release Manager can
3032
use this file as a source of information when compiling the Release Notes for a new release.
3133

@@ -131,4 +133,5 @@ $ git push origin :feature_x
131133

132134
Release Principles
133135
------------------
136+
134137
Detailed information about ACS release principles is available at https://cwiki.apache.org/confluence/display/CLOUDSTACK/Release+principles+for+Apache+CloudStack+4.6+and+up

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ several communications channels, the [mailing lists](http://cloudstack.apache.or
106106
official channels for making decisions about the project itself.
107107

108108
Mailing lists:
109+
109110
- [Development Mailing List](mailto:dev-subscribe@cloudstack.apache.org)
110111
- [Users Mailing List](mailto:users-subscribe@cloudstack.apache.org)
111112
- [Commits Mailing List](mailto:commits-subscribe@cloudstack.apache.org)

packaging/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
11
# CloudStack RPM and DEB packaging
2+
23
This directory contains all the required scripts and tools needed to build RPM and DEB packages for Apache CloudStack.
34

45
These scripts are also used by the CloudStack team to build packages for the official release of CloudStack.
56

67
# Requirements
8+
79
The RPM and DEB packages have dependencies on versions of specific libraries. Due to these dependencies the following distributions and their versions are supported by the packages.
810

911
* CentOS / RHEL: 8 and 9
1012
* Ubuntu: 20.04, 22.04, 24.04
1113
* Debian 12 (Bookworm, untested!)
1214

1315
# Building
16+
1417
Using the scripts in the *packaging* directory the RPM and DEB packages can be build.
1518

1619
## DEB
20+
1721
If you simply want to build packages go to the root directory of your CloudStack source code and run:
1822

1923
``dpkg-buildpackage``
2024

2125
This will build packages for the current distribution version you are running. If you run this on a Ubuntu 16.04 system the packages will be tailored for Ubuntu 16.04 and will not install on Ubuntu 14.04.
2226

2327
### Building cross-distribution
28+
2429
If you want to build packages for a different distribution run the *build-deb.sh* script. This will build packages with the current distribution as a suffix to the package names. E.g. *cloudstack-agent_4.9.0~xenial_all.deb*
2530

2631
Using a Docker image you can build packages for a distribution you are not running.
@@ -36,6 +41,7 @@ The following commands assume that the CloudStack source is present in **/tmp/cl
3641
The commands above will generate Ubuntu 14.04, 16.04, and 22.04 packages which you will find in */tmp* on your system after the build succeeds.
3742

3843
## RPM
44+
3945
The *package.sh* script can be used to build RPM packages for CloudStack. In the *packaging* script you can run the following command:
4046

4147
``./package.sh --pack oss --distribution el8``

plugins/storage/volume/adaptive/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ and implement the ProviderAdapter without needing to understand the internal
1111
logic of volume management, database structure, etc.
1212

1313
## Implement the Provider Interface
14+
1415
To implement a provider, create another module -- or a standalone project --
1516
and implement the following interfaces from the **org.apache.cloudstack.storage.datastore.adapter** package:
1617

@@ -20,21 +21,28 @@ and implement the following interfaces from the **org.apache.cloudstack.storage.
2021
Follow Javadoc for each class on further instructions for implementing each function.
2122

2223
## Implement the Primary Datastore Provider Plugin
24+
2325
Once the provider interface is implemented, you will need to extend the **org.apache.cloudstack.storage.datastore.provider.AdaptiveProviderDatastoreProviderImpl** class. When extending it, you simply need to implement a default
2426
constructor that creates an instance of the ProviderAdapterFactory implementation created in #2 above. Once created, you need to call the parent constructor and pass the factory object.
2527

2628
## Provide the Configuration for the Provider Plugin
29+
2730
Lastly, you need to include a module file and Spring configuration for your Primary Datastore Provider Plugin class so Cloudstack will load it during startup.
2831

2932
### Module Properties
33+
3034
This provides the hint to Cloudstack to load this as a module during startup.
35+
3136
```
3237
#resources/META-INF/cloudstack/storage-volume-<providername>/module.properties
3338
name=storage-volume-<providername>
3439
parent=storage
3540
```
41+
3642
### Spring Bean Context Configuration
43+
3744
This provides instructions of which provider implementation class to load when the Spring bean initialization is running.
45+
3846
```
3947
<!-- resources/META-INF/cloudstack/storage-volume-<providername>/spring-storage-volume-<providername>-context.xml -->
4048
<beans xmlns="http://www.springframework.org/schema/beans"
@@ -53,12 +61,16 @@ This provides instructions of which provider implementation class to load when t
5361
</bean>
5462
</beans>
5563
```
64+
5665
## Build and Deploy the Jar
66+
5767
Once you build the new jar, start Cloudstack Management Server or, if a standalone jar, add it to the classpath before start. You should now have a new storage provider of the designated name once Cloudstack finishes loading
5868
all configured modules.
5969

6070
### Test Cases
71+
6172
The following test cases should be run against configured installations of each storage array in a working Cloudstack installation.
73+
6274
1. Create New Primera Storage Pool for Zone
6375
2. Create New Primera Storage Pool for Cluster
6476
3. Update Primera Storage Pool for Zone

plugins/storage/volume/linstor/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2020
## [2025-05-07]
2121

2222
### Added
23+
2324
- Implemented storage/volume stats
2425

2526
## [2025-03-13]
@@ -49,6 +50,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4950
## [2024-12-19]
5051

5152
### Added
53+
5254
- Native CloudStack encryption support
5355

5456
## [2024-12-13]

plugins/storage/volume/storpool/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
Primary storage is associated with a cluster or zone, and it stores the virtual disks for all the VMs running on hosts in that cluster/zone.
88

99
Secondary storage stores the following:
10+
1011
* Templates — OS images that can be used to boot VMs and can include additional configuration information, such as installed applications
1112
* ISO images — disc images containing data or bootable media for operating systems
1213
* Disk volume snapshots — saved copies of VM data which can be used for data recovery or to create new templates
@@ -354,6 +355,7 @@ To change the tier via CloudStack, you can use the CloudStack API call `changeOf
354355
change offeringforvolume id={The UUID of the Volume} diskofferingid={The UUID of the disk offering} size={The current or a new size for the volume}
355356

356357
Users who were using the offerings to change the StorPool template via the `SP_TEMPLATE` detail, will continue to have this functionality but should use `changeOfferingForVolume` API call instead of:
358+
357359
- `resizeVolume` API call for DATA disk
358360
- `scaleVirtualMachine` API call for ROOT disk
359361

@@ -372,9 +374,11 @@ Add disk offering detail with API call in CloudStack CLI.
372374
Creating VM with QoS
373375

374376
Deploy virtual machine: Go to Compute> Instances> Add Instances.
377+
375378
- For the ROOT volume, choose the option `Override disk offering`. This will set the required `qc` tag from the disk offering (DO) detail.
376379

377380
Creating DATA disk with QoS
381+
378382
- Create volume via GUI/CLI and choose a disk offering which has the required `SP_QOSCLASS` detail
379383

380384
To update the tier of a ROOT/DATA volume go to Storage> Volumes and select the Volume and click on the Change disk offering for the volume in the upper right corner.

test/integration/plugins/linstor/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Linstor storage plugin
2+
23
==================================
34
This directory contains the basic VM, Volume life cycle tests for Linstor storage pool (in KVM hypervisor).
45

56
# Running tests
7+
68
===============
79
To run the basic volume tests, first update the below test data of the CloudStack environment
810

test/integration/plugins/scaleio/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# PowerFlex/ScaleIO storage plugin
2+
23
==================================
34
This directory contains the basic VM, Volume life cycle tests for PowerFlex/ScaleIO storage pool (in KVM hypervisor).
45

56
# Running tests
7+
68
===============
79
To run the basic volume tests, first update the below test data of the CloudStack environment
810

0 commit comments

Comments
 (0)