diff --git a/ApplicationAmicalsatCli/pom.xml b/ApplicationAmicalsatCli/pom.xml index 81d8db8716df19c7c1dc528a8d1e87a70323ff56..98b14755b26775ed5f0aef8c4747451966883e8d 100644 --- a/ApplicationAmicalsatCli/pom.xml +++ b/ApplicationAmicalsatCli/pom.xml @@ -101,6 +101,12 @@ + + + + + + diff --git a/ApplicationEntrySatDecoder/src/site/site.xml b/ApplicationEntrySatDecoder/src/site/site.xml new file mode 100644 index 0000000000000000000000000000000000000000..6c235d508869fe9c96f6f917fed3a1d705553868 --- /dev/null +++ b/ApplicationEntrySatDecoder/src/site/site.xml @@ -0,0 +1,35 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.6 + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ModuleAmicalsat/src/site/site.xml b/ModuleAmicalsat/src/site/site.xml new file mode 100644 index 0000000000000000000000000000000000000000..6c235d508869fe9c96f6f917fed3a1d705553868 --- /dev/null +++ b/ModuleAmicalsat/src/site/site.xml @@ -0,0 +1,35 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.6 + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ModuleConfig/src/site/site.xml b/ModuleConfig/src/site/site.xml new file mode 100644 index 0000000000000000000000000000000000000000..6c235d508869fe9c96f6f917fed3a1d705553868 --- /dev/null +++ b/ModuleConfig/src/site/site.xml @@ -0,0 +1,35 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.6 + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ModuleCubesatSim/pom.xml b/ModuleCubesatSim/pom.xml index 9e63da5363994f37a502ec8fa9db8a40a3b5be59..d8e48ebdd898ce94f56cea0f5645cc62280be9e0 100644 --- a/ModuleCubesatSim/pom.xml +++ b/ModuleCubesatSim/pom.xml @@ -72,12 +72,7 @@ - -org.junit.jupiter - junit-jupiter-engine - 5.5.2 - test - + diff --git a/ModuleCubesatSim/src/main/java/org/josast/CubesatSim/influxDB/InfluxDBInstance.java b/ModuleCubesatSim/src/main/java/org/josast/CubesatSim/influxDB/InfluxDBInstance.java index ae2667fce4999e48fee604e26e02d49eb2db2d59..4fa4d4066759231c5cff36029832fa3b932133c0 100644 --- a/ModuleCubesatSim/src/main/java/org/josast/CubesatSim/influxDB/InfluxDBInstance.java +++ b/ModuleCubesatSim/src/main/java/org/josast/CubesatSim/influxDB/InfluxDBInstance.java @@ -8,14 +8,14 @@ import org.influxdb.InfluxDBIOException; import org.influxdb.dto.BatchPoints; import org.influxdb.dto.Pong; -/** - * Manage InflusDB Instance. +/** Manage InflusDB Instance. * * @author christophe * */ public final class InfluxDBInstance { + /** log */ private Logger log = Logger.getLogger(getClass().getName()); static InfluxDBInstance influxDB = null; diff --git a/ModuleCubesatSim/src/main/java/org/josast/CubesatSim/influxDB/InfluxDatabaseConfig.java b/ModuleCubesatSim/src/main/java/org/josast/CubesatSim/influxDB/InfluxDatabaseConfig.java index 93f1692ac06159ba90bef6210667a7776aa869cb..ebb4bc07a37899f9d6f32cc523fec4d3f24c307d 100644 --- a/ModuleCubesatSim/src/main/java/org/josast/CubesatSim/influxDB/InfluxDatabaseConfig.java +++ b/ModuleCubesatSim/src/main/java/org/josast/CubesatSim/influxDB/InfluxDatabaseConfig.java @@ -15,7 +15,7 @@ public class InfluxDatabaseConfig extends ConfigObject { /** * @param configFilename */ - public InfluxDatabaseConfig(String configFilename) { + public InfluxDatabaseConfig(final String configFilename) { super(configFilename); String temp = ConfigFile.GetProperty("adresse"); diff --git a/ModuleCubesatSim/src/site/site.xml b/ModuleCubesatSim/src/site/site.xml new file mode 100644 index 0000000000000000000000000000000000000000..6c235d508869fe9c96f6f917fed3a1d705553868 --- /dev/null +++ b/ModuleCubesatSim/src/site/site.xml @@ -0,0 +1,35 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.6 + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ModuleEquationKepler/src/site/site.xml b/ModuleEquationKepler/src/site/site.xml new file mode 100644 index 0000000000000000000000000000000000000000..6c235d508869fe9c96f6f917fed3a1d705553868 --- /dev/null +++ b/ModuleEquationKepler/src/site/site.xml @@ -0,0 +1,35 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.6 + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ModuleInflux/src/site/site.xml b/ModuleInflux/src/site/site.xml new file mode 100644 index 0000000000000000000000000000000000000000..6c235d508869fe9c96f6f917fed3a1d705553868 --- /dev/null +++ b/ModuleInflux/src/site/site.xml @@ -0,0 +1,35 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.6 + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ModuleJourJulien/src/site/site.xml b/ModuleJourJulien/src/site/site.xml new file mode 100644 index 0000000000000000000000000000000000000000..6c235d508869fe9c96f6f917fed3a1d705553868 --- /dev/null +++ b/ModuleJourJulien/src/site/site.xml @@ -0,0 +1,35 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.6 + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ModuleSound/src/site/site.xml b/ModuleSound/src/site/site.xml new file mode 100644 index 0000000000000000000000000000000000000000..6c235d508869fe9c96f6f917fed3a1d705553868 --- /dev/null +++ b/ModuleSound/src/site/site.xml @@ -0,0 +1,35 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.6 + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ModuleSoundModem/src/site/site.xml b/ModuleSoundModem/src/site/site.xml new file mode 100644 index 0000000000000000000000000000000000000000..6c235d508869fe9c96f6f917fed3a1d705553868 --- /dev/null +++ b/ModuleSoundModem/src/site/site.xml @@ -0,0 +1,35 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.6 + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ModuleUtil/src/site/site.xml b/ModuleUtil/src/site/site.xml new file mode 100644 index 0000000000000000000000000000000000000000..6c235d508869fe9c96f6f917fed3a1d705553868 --- /dev/null +++ b/ModuleUtil/src/site/site.xml @@ -0,0 +1,35 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.6 + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/pom.xml b/pom.xml index 52848269ff8b700110011505393785be4d7fdf06..2fa6197d37eeddcc38036b1f1b3e42c3f8f404e6 100644 --- a/pom.xml +++ b/pom.xml @@ -15,8 +15,36 @@ https://code.electrolab.fr/xtof/josast - - + + + Amsat-Francophone + http://www.amsat-f.org + + + + GNU LESSER GENERAL PUBLIC LICENSE 2.1 + https://www.gnu.org/licenses/old-licenses/gpl-2.0.fr.html + + + + + + + + Christophe Mercier + Christophe + christophe.mcr+josast@gmail.com + +1 + Amsat-Francophone + http://www.amsat-f.org + + Tech lead + développeur + + + + + UTF-8 1.8 @@ -671,6 +699,16 @@ + + + + + + + site-projet + scp://exemple.org/www/ + + diff --git a/src/site/markdown/MarkdownSyntax.md b/src/site/markdown/MarkdownSyntax.md new file mode 100644 index 0000000000000000000000000000000000000000..514db39f7744c3ff1cbfca913a137c55ef16cc70 --- /dev/null +++ b/src/site/markdown/MarkdownSyntax.md @@ -0,0 +1,89 @@ +# Markdown Syntax # + +The [Maven doxia module] for [Markdown] uses the [pegdown] processor +to render HTML. Pegdown supports several extensions to the Markdown +syntax. This documents shows example of syntax you can use in your +Maven site and the results. + +## Text ## + +| Markup | Result | +|:-----------------------------------:|:-------------------------------:| +| ``This text is **strong**.`` | This text is **strong**. | +| ``This text is also __strong__.`` | This text is also __strong__. | +| ``This text is *emphasized*.`` | This text is *emphasized* | +| ``This text is also _emphasized_.`` | This text is also _emphasized_. | +| ```This is ``some code``.``` | This is ``some code``. | +| ``This is also ```some code```.`` | This is also ```some code```. | + +## Headings ## + +See [this page](headings.html). + +## Lists ## + +## Links ## + +## Images ## + +## Code ## + +## Footnotes ## + +Here is some text containing a footnote[^somesamplefootnote]. You can then continue your thought... + +[^somesamplefootnote]: Here is the text of the footnote itself. + +Even go to a new paragraph and the footnotes with go to the bottom of the document[^documentdetails]. + +[^documentdetails]: Depending on the final form of your document, of course. See the documentation and experiment. + + This footnote has a second paragraph. + +## Tables ## + +### Simple Table ### + +#### Markup #### + +``` +| First Header | Second Header | Third Header | +| :----------- | :-----------: | -------------------: | +| First row | Data | Very long data entry | +| Second row | **Cell** | *Cell* | +``` + +#### Result #### + +| First Header | Second Header | Third Header | +| :----------- | :-----------: | -------------------: | +| First row | Data | Very long data entry | +| Second row | **Cell** | *Cell* | + +### Table with cells spanning multiple columns ### + +#### Markup #### + +``` +| | Grouping || +| First Header | Second Header | Third Header | +| ------------ | :-----------: | -----------: | +| Content | *Long Cell* || +| Content | **Cell** | Cell | +| New section | More | Data | +``` + +#### Result #### + +| | Grouping || +| First Header | Second Header | Third Header | +| ------------ | :-----------: | -----------: | +| Content | *Long Cell* || +| Content | **Cell** | Cell | +| New section | More | Data | + + +[Maven doxia module]: http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-markdown/ +[Markdown]: http://daringfireball.net/projects/markdown/ "Main Markdown site" +[pegdown]: https://github.com/sirthias/pegdown + diff --git a/src/site/markdown/namingconvention.md b/src/site/markdown/namingconvention.md new file mode 100644 index 0000000000000000000000000000000000000000..418f4eb20591006f43f05c847f037e5942db423f --- /dev/null +++ b/src/site/markdown/namingconvention.md @@ -0,0 +1,51 @@ +# JOSAST naming convention + +## Application / Module / Web application + + An **Application** is an executable jar. Two types of application can be produce + + * Command line application + * Graphic application + + A **Module** is a library jar. A module address a functionality. An application is an integration of modules. + + A **Web Application** is jar / war used for a web service. + +### naming convention + +| type | Rule | +| :-----------------------:| :---------------------------:| +| Application Command line | **Application***name***cli** | +| Application HMI | **Application**Name | +| Module | **Module**Name | +| Web Application | **Web**Name | + + +## package naming convention + +The package naming convention is the following : + + **org.josast.***name*.*...* + The *name* is the module name + +## Semantic Commit Messages + + +Format: `(): ` + +`` is optional + + +- `feat`: (new feature for the user, not a new feature for build script) +- `fix`: (bug fix for the user, not a fix to a build script) +- `docs`: (changes to the documentation) +- `style`: (formatting, missing semi colons, etc; no production code change) +- `refactor`: (refactoring production code, eg. renaming a variable) +- `test`: (adding missing tests, refactoring tests; no production code change) +- `chore`: (updating grunt tasks etc; no production code change) + +References: + +- https://www.conventionalcommits.org/ +- https://seesparkbox.com/foundry/semantic_commit_messages +- http://karma-runner.github.io/1.0/dev/git-commit-msg.html \ No newline at end of file diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 0000000000000000000000000000000000000000..5fc4af9f075c61ceff6842d0c7155d28dd5f1041 --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,42 @@ + + + + + org.apache.maven.skins + maven-fluido-skin + 1.6 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file