actions-for-docs (#919)

* updated docs action with version state

* script updates

* misc doc system updates

* Update build.yml

remove versions logic, since zip contains version info now.

* Update build.yml

corrected git add command

* update version format

* updated docs site url
This commit is contained in:
Jonathan Shook
2023-01-13 11:57:08 -06:00
committed by GitHub
parent 97e992bce8
commit ff188d4860
33 changed files with 327 additions and 120 deletions

View File

@@ -73,6 +73,10 @@
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>version.properties</include>
<include>nb_version_info.md</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>

View File

@@ -16,7 +16,7 @@
package io.nosqlbench.api.docsapi.docexporter;
import io.nosqlbench.api.spi.BundledApp;
import io.nosqlbench.api.apps.BundledApp;
import io.nosqlbench.nb.annotations.Service;
import joptsimple.OptionParser;
import joptsimple.OptionSet;

View File

@@ -0,0 +1,34 @@
/*
* Copyright (c) 2023 nosqlbench
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.nosqlbench.api.docsapi.docexporter;
import io.nosqlbench.api.content.NBIO;
import io.nosqlbench.api.docsapi.BundledMarkdownManifest;
import io.nosqlbench.api.docsapi.Docs;
import io.nosqlbench.api.docsapi.DocsBinder;
import io.nosqlbench.nb.annotations.Service;
@Service(value=BundledMarkdownManifest.class,selector = "versions")
public class BundledVersionManifest implements BundledMarkdownManifest {
@Override
public DocsBinder getDocs() {
return new Docs()
.namespace("versions")
.addPath(NBIO.classpath().name("nb_version_info.md").one().asPath())
.asDocsBinder();
}
}

View File

@@ -0,0 +1,9 @@
# Version Info
The version of NB5 which provided some of the docs content is:
```
version=${project.version}
groupId=${project.groupId}
artifactId=${project.artifactId}
```