Comments (5)
Seems this story may not be needed, or needs to be fleshed out better.
There's a couple options in generating go documentation - first is an automatic process is triggering documentation builds on https://godoc.org/opendev.org/airship/airshipctl
alternatively there is a way to generate html files from godoc directly that could be uploaded to a web server:
make godoc
wget -r -np -N -E -p -k http://localhost:8080/pkg/opendev.org/airship/airshipctl/
upload the downloaded files from the wget command
from airshipctl.
I think we should probably just host the source docs on godoc.org.
We do have Sphinx docs inside of our project currently though. It seems we should host these at RTD still.
The stuff on godoc.org can be more like the technical docs and our stuff on RTD can be more pointed towards end users.
from airshipctl.
Need to configure zuul roles, and change Makefile etc to get this working
from airshipctl.
New Related Change
Link: https://review.opendev.org/711634
Subject: [WIP][#38] Add end-user documentation to project
Authored By: Alexander Hughes ([email protected])
from airshipctl.
Corresponding change has been merged, satisfying this issue.
from airshipctl.
Related Issues (20)
- Support multiple versions of clusterctl HOT 5
- AIAP: Document the requirements for the infrastructure builder image HOT 4
- AIAP: Create a multi-node `infra-builder` image HOT 3
- AIAP: Using the `.git` suffix on repository names causes runner pod failure HOT 2
- AIAP: support non test GPG keys HOT 5
- Provide Calico CNI IPv4/v6/Dual Stack Support in Airshipctl HOT 2
- AIAP : Support for DualStack IPv6 HOT 2
- Install latest docker version within build_gate.sh script HOT 1
- Enable extraction of target/workload cluster artifacts HOT 3
- AIAP: Shift gates to use AIAP HOT 3
- AIAP: Documentation redirect HOT 3
- source|target version replacement for qcow_bundle is missing. HOT 4
- AIAP : Add support for IPV6 infra to test Airship-in-a-pod in Zuul Gates HOT 2
- 10_build_gate.sh fails to locate ensure-docker ansible role HOT 3
- `make manifests` target doesn't work HOT 1
- Create zuul job which performs make generate/make manifests HOT 1
- Develop new kubeconfig workflow HOT 2
- Allow to resume phase plan execution from a certain phase HOT 2
- Fail to create kubeval-validator image. HOT 2
- namespace-v1.json is missing when running "airshipctl plan validate deploy-gating" HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from airshipctl.