https://github.com/paradocs-cli/paradocs

paradocs is a tool for automating documentation for code including IaC, k8s, and modern programming languages.
https://github.com/paradocs-cli/paradocs

documentation golang terraform

Last synced: 5 months ago
JSON representation

paradocs is a tool for automating documentation for code including IaC, k8s, and modern programming languages.

• Host: GitHub
• URL: https://github.com/paradocs-cli/paradocs
• Owner: paradocs-cli
• License: mit
• Created: 2022-01-31T17:04:43.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-02T21:12:07.000Z (over 3 years ago)
• Last Synced: 2024-11-15T03:52:40.274Z (over 1 year ago)
• Topics: documentation, golang, terraform
• Language: Go
• Homepage:
• Size: 4.28 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ParaDocs 

## What the tool is for: 

* Generating documentation for cloud native tools

* Generating documentation for cloud resources deployed via Terraform, Pulumi, ARM, etc.

* Generating documentation for k8s(Helm etc.)

* Future use cases

  * Docs generated for modern programming languages

  * Docs generated for Projects via Azure DevOps, Jira, and GitHub 

  * Integration for agnostic pipeline support 

## How to install: 

  * Run ```make all``` in your shell 

    * This will compile the exe and add it to your $PATH 

    * If the ```make``` command fails, install Make by using Chocolatey and running ```choco make install```

  * Test with ```paradocs --help```

## How to use ParaDocs:

### Authentication for state providers: 

#### Google Cloud 

[Oauth2Token Creation](https://developers.google.com/identity/protocols/oauth2) (Needed for authentication to Cloud Storage API)


[REST API Docs](https://cloud.google.com/storage/docs/downloading-objects) (You will need to authorize your token as seen below)


![img.png](assets/gcpapi.png)

#### AWS

[Access Developer Credentials](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html)

![Developer Creds](assets/awscredssnip.png)

* You will need the following 

  * Session Token 

  * Access Key

  * Secret Access Key

  * Region 

  * S3 Bucket Name 

  * Object Name/Path

#### Azure

[Create a SAS token for storage blob](https://docs.microsoft.com/en-us/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=Containers) 


![Access Blob](assets/gensas.png)


Only grab the actual token field for cli use


![Only Token](assets/sastoken.png)

#### Terraform Cloud (TFC ONLY NO ENTERPRISE CURRENTLY!) 

[Create API Token](https://www.terraform.io/cloud-docs/users-teams-organizations/api-tokens)

* You will need the following:

  * API token 

  * Workspace ID

### Terraform documentation:

### Sample commands:

* ```paradocs code terraform --working-dir ```

  * All docs that are generated will be stored in current working directory

  * Future support being added to specificy what directory to ouput too as well as running against remote code stored in GitHub, Gitlab, etc

## How to contribute:

  * Request access 

  * Fork repo 

  * Add features 

  * Submit PR 

### Working with Cobra:

  [Cobra CLI Docs](https://github.com/spf13/cobra) 


  [Viper Docs](https://github.com/spf13/viper)

### Pull requests:

#### All PR's have the following policies for approval: 

1. Minimum required reviewers 

2. Code review by code owners 

3. All checks must pass(builds)

4. Code merged to main via PR only