Skip to content

Commit

Permalink
added doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jlangch committed Sep 19, 2023
1 parent 64a74c9 commit fe2b098
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
import com.github.jlangch.venice.impl.docgen.cheatsheet.modules.ModuleAnsiSection;
import com.github.jlangch.venice.impl.docgen.cheatsheet.modules.ModuleAppSection;
import com.github.jlangch.venice.impl.docgen.cheatsheet.modules.ModuleBenchmarkSection;
import com.github.jlangch.venice.impl.docgen.cheatsheet.modules.ModuleCargoArangoDBSection;
import com.github.jlangch.venice.impl.docgen.cheatsheet.modules.ModuleCargoSection;
import com.github.jlangch.venice.impl.docgen.cheatsheet.modules.ModuleComponentSection;
import com.github.jlangch.venice.impl.docgen.cheatsheet.modules.ModuleConfigSection;
Expand Down Expand Up @@ -120,7 +121,8 @@ public DocGenerator(final boolean runExamples) {
"java", "semver", "excel", "hexdump",
"shell", "geoip", "benchmark", "component",
"config", "parsifal", "grep", "test",
"fonts", "qrref", "docker", "cargo"));
"fonts", "qrref",
"docker", "cargo", "cargo-arangodb"));

final IVeniceInterpreter venice = new VeniceInterpreter(new AcceptAllInterceptor());

Expand Down Expand Up @@ -396,6 +398,7 @@ private List<DocSection> getModulesLeftSections() {
new ModuleMavenSection(diBuilder).section(),
new ModuleDockerSection(diBuilder).section(),
new ModuleCargoSection(diBuilder).section(),
new ModuleCargoArangoDBSection(diBuilder).section(),
new ModuleTracingSection(diBuilder).section(),
new ModuleShellSection(diBuilder).section(),
new ModuleAnsiSection(diBuilder).section(),
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/* __ __ _
* \ \ / /__ _ __ (_) ___ ___
* \ \/ / _ \ '_ \| |/ __/ _ \
* \ / __/ | | | | (_| __/
* \/ \___|_| |_|_|\___\___|
*
*
* Copyright 2017-2023 Venice
*
* 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 com.github.jlangch.venice.impl.docgen.cheatsheet.modules;

import com.github.jlangch.venice.impl.docgen.cheatsheet.DocItemBuilder;
import com.github.jlangch.venice.impl.docgen.cheatsheet.DocSection;
import com.github.jlangch.venice.impl.docgen.cheatsheet.ISectionBuilder;


public class ModuleCargoArangoDBSection implements ISectionBuilder {

public ModuleCargoArangoDBSection(final DocItemBuilder diBuilder) {
this.diBuilder = diBuilder;
}

@Override
public DocSection section() {
final DocSection section = new DocSection(
"Cargo ArangoDB",
"ArangoDB Testcontainers",
"modules.cargo-arangodb");

final DocSection all = new DocSection("(load-module :cargo-arangodb)", id());
section.addSection(all);

final DocSection docker = new DocSection("ArangoDB", id());
all.addSection(docker);
docker.addItem(diBuilder.getDocItem("cargo-arangodb/start", false));
docker.addItem(diBuilder.getDocItem("cargo-arangodb/stop", false));

return section;
}

private String id() {
return diBuilder.id();
}

private final DocItemBuilder diBuilder;
}

0 comments on commit fe2b098

Please sign in to comment.