Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare for organization rename (#62) #63

Merged
merged 1 commit into from
Aug 1, 2021
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
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# crdoc

[![Go Report Card](https://goreportcard.com/badge/github.com/mesh-for-data/crdoc)](https://goreportcard.com/report/github.com/mesh-for-data/crdoc)
[![Go Reference](https://pkg.go.dev/badge/github.com/mesh-for-data/crdoc.svg)](https://pkg.go.dev/github.com/mesh-for-data/crdoc)
[![golangci-lint](https://github.com/mesh-for-data/crdoc/actions/workflows/golangci-lint.yml/badge.svg)](https://github.com/mesh-for-data/crdoc/actions/workflows/golangci-lint.yml)
[![CodeQL](https://github.com/mesh-for-data/crdoc/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/mesh-for-data/crdoc/actions/workflows/codeql-analysis.yml)
[![gosec](https://github.com/mesh-for-data/crdoc/actions/workflows/golang-security.yml/badge.svg)](https://github.com/mesh-for-data/crdoc/actions/workflows/golang-security.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/fybrik/crdoc)](https://goreportcard.com/report/github.com/fybrik/crdoc)
[![Go Reference](https://pkg.go.dev/badge/github.com/fybrik/crdoc.svg)](https://pkg.go.dev/github.com/fybrik/crdoc)
[![golangci-lint](https://github.com/fybrik/crdoc/actions/workflows/golangci-lint.yml/badge.svg)](https://github.com/fybrik/crdoc/actions/workflows/golangci-lint.yml)
[![CodeQL](https://github.com/fybrik/crdoc/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/fybrik/crdoc/actions/workflows/codeql-analysis.yml)
[![gosec](https://github.com/fybrik/crdoc/actions/workflows/golang-security.yml/badge.svg)](https://github.com/fybrik/crdoc/actions/workflows/golang-security.yml)

Generate markdown documentation from Kubernetes `CustomResourceDefinition` YAML files.

## Install

Download the appropriate version for your platform from [Releases](https://github.com/mesh-for-data/crdoc/releases/latest).
Download the appropriate version for your platform from [Releases](https://github.com/fybrik/crdoc/releases/latest).
You may want to install the binary to somewhere in your system's PATH such as `/usr/local/bin`.

Alternatively, if you have go 1.16 or later then you can also use `go install`.
This will put the latest released version of `crdoc` in `$(go env GOPATH)/bin`:

```bash
go install github.com/mesh-for-data/crdoc@latest
go install fybrik.io/crdoc@latest
```

## Usage
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/mesh-for-data/crdoc
module fybrik.io/crdoc

go 1.16

Expand Down
6 changes: 3 additions & 3 deletions hack/get-crdoc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ set -e
usage() {
this=$1
cat <<EOF
$this: download go binaries for mesh-for-data/crdoc
$this: download go binaries for fybrik/crdoc

Usage: $this [-b] bindir [-d] [tag]
-b sets bindir or installation directory, Defaults to ./bin
-d turns on debug logging
[tag] is a tag from
https://github.com/mesh-for-data/crdoc/releases
https://github.com/fybrik/crdoc/releases
If tag is missing, then the latest will be used.

Generated by godownloader
Expand Down Expand Up @@ -350,7 +350,7 @@ End of functions from https://github.com/client9/shlib
EOF

PROJECT_NAME="crdoc"
OWNER=mesh-for-data
OWNER=fybrik
REPO="crdoc"
BINARY=crdoc
FORMAT=tar.gz
Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (
"github.com/spf13/cobra"
"github.com/spf13/viper"

pkg "github.com/mesh-for-data/crdoc/pkg/builder"
pkg "fybrik.io/crdoc/pkg/builder"
)

const (
Expand Down
2 changes: 1 addition & 1 deletion pkg/builder/builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ import (
"strings"
"text/template"

"fybrik.io/crdoc/pkg/functions"
"github.com/Masterminds/sprig/v3"
"github.com/mesh-for-data/crdoc/pkg/functions"
log "github.com/sirupsen/logrus"
"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
)
Expand Down
2 changes: 1 addition & 1 deletion pkg/functions/anchorize.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import (

"golang.org/x/text/transform"

"github.com/mesh-for-data/crdoc/pkg/pools"
"fybrik.io/crdoc/pkg/pools"
)

// Anchorize sanitizes anchor names using GitHub style anchors.
Expand Down