-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
79 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # Gofluence | ||
| [](https://github.com/beto20/gofluence) | ||
| [](https://github.com/beto20/gofluence) | ||
| [](./LICENSE) | ||
| [](https://goreportcard.com/report/github.com/beto20/gofluence) | ||
|
|
||
| ## Description | ||
| Gofluence is a CLI application and DevOps tool that helps you build documentation on Confluence pages. It also works well with CI/CD pipelines because it is easy to integrate and keeps your project documentation updated in a simple way. | ||
|
|
||
| - Currently support: | ||
| - Java projects | ||
|
|
||
| ## Use case | ||
| - CLI application | ||
| - You can use it as a CLI application in Java projects, and it will generate documentation for your project. | ||
|
|
||
| - DevOps tool | ||
| - You can integrate it into a CI/CD pipeline as a new step or an existing step, and it will generate documentation for your project. | ||
|
|
||
| ## Getting Started | ||
| - Requires Go version 1.22 or 1.23 | ||
|
|
||
| 1. Clone the repository | ||
| ``` | ||
| git clone https://github.com/beto20/Gofluence.git | ||
| ``` | ||
| 2. Execute unit test | ||
| ``` | ||
| go test | ||
| ``` | ||
| 3. Build the project | ||
| ``` | ||
| go build cmd/gofluence/main.go | ||
| ``` | ||
| 4. Move the binary to the root of the new project | ||
| 5. Execute the binary with the following flag | ||
| ``` | ||
| ./main -b branch -c commit-hash -p prefix-project -t confluence-token -u confluence-url -rn repository-name -ct storage-container -cs storage-string-connection | ||
| ``` | ||
| ## Contribute | ||
| Gofluence is an Open-Source Software (OSS), so if you would like to contribute with fixes, new features, integrations, or other improvements, I will guide you step by step. | ||
| 1. You must check the feature backlog or ticket issues. | ||
| 2. Choose an activity you would like to develop. | ||
| 3. Fork the repository. | ||
| 4. Create a new branch. | ||
| 5. Add and commit your changes. Use a proper commit message. | ||
| 6. Push to the branch. | ||
| 7. Open a pull request and wait for the review and feedback. | ||
| 8. If there are any observations or improvements suggested for your code, take them positively. | ||
| 9. If there are no observations, your PR will be merged. | ||
| 10. Congratulations! You have successfully contributed to one of the greatest Go OSS projects. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <title>Document</title> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /> | ||
| <meta name="description" content="Description"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"> | ||
| <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"> | ||
| </head> | ||
| <body> | ||
| <div id="app"></div> | ||
|
|
||
|
|
||
|
|
||
| <script> | ||
| window.$docsify = { | ||
| name: '', | ||
| repo: '' | ||
| } | ||
|
|
||
| </script> | ||
| <!-- Docsify v4 --> | ||
| <script src="//cdn.jsdelivr.net/npm/docsify@4"></script> | ||
| </body> | ||
| </html> |