go.science.ru.nl

module

v0.0.16 Latest Latest Go to latest Published: Dec 21, 2022 License: Apache-2.0

Details

Packages gaan gewoon in de top-level directory. Er zijn een paar directories voor "support":

public: een index.html om Go package imports mogelijk te maken voor go.science.ru.nl
hugo: hugo site om de Go package te genereren, wordt in public/pkg gezet. Dit geheel werkt samen met cmd/doc2hugo om alles te publiceren.
cmd: plek for Go CLIs.

Alle andere top level directories zijn een Go package zijn. Hou een package redelijk schoon, dat betekent:

Geen binaries erin (binaries die handig zijn kunnen in cmd).
Goede Go documentatie. Documentatie kan via de "godoc" server geraadpleegd worden: https://go.science.ru.nl/pkg
Link de LICENCE file in je nieuwe repo, zodat onze packages ook opgepikt kunnen worden door "pkg.go.dev"

De public/index.html is belangrijk want die vertelt go get waar go.science.ru.nl packages te vinden zijn tijdens het compileren.

Via een Gitlab pipeline wordt het allemaal aan elkaar geknoopt:

Eind resultaat:

go.science.ru.nl is het import path voor onze Go code. And op https://go.science.ru.nl/pkg kan alle Go documentatie worden gelezen.

Path	Synopsis
cmd
cfne
csvne
doc2hugo doc2hugo converts godoc formatted package documentation into Markdown format with a hugo header.	doc2hugo converts godoc formatted package documentation into Markdown format with a hugo header.
f2bne
graaf
graaf/sdk
hosts2prom
hstrip
nbne
promconf
testscience This is a small exmaple program that pulls down a go.science.ru.nl package and uses it to print the current mounts visible from this process.	This is a small exmaple program that pulls down a go.science.ru.nl package and uses it to print the current mounts visible from this process.
doc2md Package doc2md creates a markdown representation of a package's godoc.	Package doc2md creates a markdown representation of a package's godoc.
log Package log implements a small wrapper around the std lib log package.	Package log implements a small wrapper around the std lib log package.
mountinfo Package mountinfo gives information on the current mount for the running process.	Package mountinfo gives information on the current mount for the running process.
promfmt Package promfmt exports prometheus metrics to the default text format.	Package promfmt exports prometheus metrics to the default text format.
source Package source dumps the source code of the current binary to standard output.	Package source dumps the source code of the current binary to standard output.