Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions znai-docs/znai/hub/build-artifacts-watch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Todo

Please create [GitHub Issue](https://github.com/testingisdocumenting/znai/issues) if you are interested in automatically watching a set of directories for
built documentations to automatically upload them to Hub.
5 changes: 5 additions & 0 deletions znai-docs/znai/hub/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Znai has a server mode that can act as a Hub for your company documentations.
In addition to serving static content, Hub provides:
* Landing page, with all the documentations separated by sections
* On-demand upload via CLI
* Automatic build artifacts watching to grab the latest docs
27 changes: 27 additions & 0 deletions znai-docs/znai/hub/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Config File

Create the enterprise config file and set the path where Znai will store uploaded documentation:
```json {title: "znai-enterprise.cfg"}
{
"znaiDocStoragePath": "/path/to-store-docs-to-serve"
}
```

# Run In Server Mode

Run Znai in server mode in the directory with the config file:
```cli
znai --serve --port=<port>
```

# Upload Documentation

Set `ZNAI_SERVER_URL` environment variable to the full url of the server, e.g.:
```cli
export ZNAI_SERVER_URL=http://localhost:7070
```

Now you can run `upload` command to build and upload a documentation:
```cli
znai --deploy=/path/where/docresources/generate --doc-id=my-doc-id --upload
```
2 changes: 1 addition & 1 deletion znai-docs/znai/introduction/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,5 +105,5 @@ Here is an example of znai publishing its documentation to github pages
Znai has enterprise mode that lets you run Documentation hub inside your organization.
It is completely free and open sourced.

Please create a GitHub issue if you want to try it out. I don't document it yet as I only have a couple of scenarios
Please create a [GitHub Issue](https://github.com/testingisdocumenting/znai/issues) if you want to try it out. I don't document it yet as I only have a couple of scenarios
I tried it on, and I need more input.
1 change: 1 addition & 0 deletions znai-docs/znai/snippets/external-code-snippets.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Embedding Content

# Long Section Name Long Section NameLong Section NameLong Section NameLong Section NameLong Section NameLong Section NameLong Section Name
To reduce documentation maintenance burden avoid copy and paste of code snippets.
Embed content by referencing existing files using the `include-file` plugin instead.

Expand Down
4 changes: 4 additions & 0 deletions znai-docs/znai/toc
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@ configuration
top-header
deployment
additional-files
hub
introduction
setup
build-artifacts-watch
example-references
domain
api
Expand Down
Loading