Skip to content

Commit

Permalink
[#15]: Generate documentation in MetricsHub Community Connectors
Browse files Browse the repository at this point in the history
* Add MetricsHub Connector Maven Plugin configuration to pom.xml file.
* Update site.xml to generate documentation.
* Add bodyClass for better styling in site.xml file.
* Create site.css for consistent colors in syntax highlighting.
  • Loading branch information
kawtarBK9 committed Jan 11, 2024
1 parent c49f180 commit 76c0dbb
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,10 @@ dependency-reduced-pom.xml
buildNumber.properties
.mvn/timing.properties
.mvn/wrapper/maven-wrapper.jar

# IntelliJ IDEA files
*.iml
.idea/
*.iws
*.ipr

7 changes: 7 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,13 @@
<version>3.4.5</version>
</plugin>

<!-- The MetricsHub Connector Maven Plugin -->
<plugin>
<groupId>org.sentrysoftware.maven</groupId>
<artifactId>metricshub-connector-maven-plugin</artifactId>
<version>1.0.00-SNAPSHOT</version>
</plugin>

</plugins>
</reporting>

Expand Down
24 changes: 24 additions & 0 deletions src/site/resources/css/site.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.community-connector-class code[class*=language-js] {
background-color: #f9f2f4;
color: #c7254e;
}

.community-connector-class code[class*=language-js] .token.punctuation {
color: #a1a1a1;
}

.community-connector-class code[class*=language-js] .token.operator {
color: #3e3f58;
}

.community-connector-class code[class*=language-js] .token.string {
color: #c96a43;
}

.community-connector-class code[class*=language-js]::selection,
.community-connector-class code[class*=language-js] ::selection
{
text-shadow: none;
background: #4f62ad;
color: white;
}
6 changes: 6 additions & 0 deletions src/site/site.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<custom>
<noDefaultLinks>true</noDefaultLinks>
<keywords>metricshub, community, connector, hardware, system</keywords>
<bodyClass>community-connector-class</bodyClass>
</custom>

<bannerLeft>
Expand All @@ -27,6 +28,11 @@
<item name="Getting Started" href="index.html" />
</menu>

<menu name="MetricsHub Connectors">
<item name="Supported Platforms" href="platform-requirements.html " />
<item name="Reference" href="metricshub-connector-reference.html"/>
</menu>

<menu ref="reports" />
</body>

Expand Down

0 comments on commit 76c0dbb

Please sign in to comment.