GithubHelp home page GithubHelp logo

Comments (5)

alexander-hughes avatar alexander-hughes commented on July 30, 2024

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.

ianpittwood avatar ianpittwood commented on July 30, 2024

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.

jezogwza avatar jezogwza commented on July 30, 2024

Need to configure zuul roles, and change Makefile etc to get this working

from airshipctl.

airshipbot avatar airshipbot commented on July 30, 2024

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.

alexander-hughes avatar alexander-hughes commented on July 30, 2024

Corresponding change has been merged, satisfying this issue.

from airshipctl.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.