go.science.ru.nl

module
v0.0.44 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 27, 2023 License: GPL-3.0

README

C&CZ Main Go Repository

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:

  • de Go code wordt getest
  • de documentatie wordt eruit gehaald en in hugo/content/pkg neer gezet
  • hugo compileert de 'site' naar public/pkg

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.

Directories

Path Synopsis
cmd
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.
Package doc2md creates a markdown representation of a package's godoc.
Package doc2md creates a markdown representation of a package's godoc.
Package log implements a small wrapper around the std lib log package.
Package log implements a small wrapper around the std lib log package.
Package mountinfo gives information on the current mount for the running process.
Package mountinfo gives information on the current mount for the running process.
Package promfmt exports prometheus metrics to the default text format.
Package promfmt exports prometheus metrics to the default text format.
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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL