Skip to content

Commit

Permalink
docs: publish v1.0.0 release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
kamilsk committed Dec 1, 2022
1 parent d112046 commit cbfd1cf
Show file tree
Hide file tree
Showing 10 changed files with 42 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/404.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html><html><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><title>404: This page could not be found</title><meta name="next-head-count" content="3"/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-c67a75d1b6f99dc8.js"></script><script src="/_next/static/chunks/webpack-38cee4c0e358b1a3.js" defer=""></script><script src="/_next/static/chunks/framework-2c79e2a64abdb08b.js" defer=""></script><script src="/_next/static/chunks/main-d1728c3a778f1232.js" defer=""></script><script src="/_next/static/chunks/pages/_app-aea6920bd27938ca.js" defer=""></script><script src="/_next/static/chunks/pages/_error-3986dd5834f581dc.js" defer=""></script><script src="/_next/static/d_O3aMWKeEJ7HCj8xw83O/_buildManifest.js" defer=""></script><script src="/_next/static/d_O3aMWKeEJ7HCj8xw83O/_ssgManifest.js" defer=""></script></head><body><div id="__next"><div style="font-family:system-ui,&quot;Segoe UI&quot;,Roboto,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;;height:100vh;text-align:center;display:flex;flex-direction:column;align-items:center;justify-content:center"><div><style>body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}</style><h1 class="next-error-h1" style="display:inline-block;margin:0 20px 0 0;padding-right:23px;font-size:24px;font-weight:500;vertical-align:top;line-height:49px">404</h1><div style="display:inline-block;text-align:left"><h2 style="font-size:14px;font-weight:400;line-height:49px;margin:0">This page could not be found<!-- -->.</h2></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"statusCode":404}},"page":"/_error","query":{},"buildId":"d_O3aMWKeEJ7HCj8xw83O","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>
<!DOCTYPE html><html><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><title>404: This page could not be found</title><meta name="next-head-count" content="3"/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-c67a75d1b6f99dc8.js"></script><script src="/_next/static/chunks/webpack-38cee4c0e358b1a3.js" defer=""></script><script src="/_next/static/chunks/framework-2c79e2a64abdb08b.js" defer=""></script><script src="/_next/static/chunks/main-d1728c3a778f1232.js" defer=""></script><script src="/_next/static/chunks/pages/_app-aea6920bd27938ca.js" defer=""></script><script src="/_next/static/chunks/pages/_error-3986dd5834f581dc.js" defer=""></script><script src="/_next/static/Be7GKARz4at19fmnu6Tej/_buildManifest.js" defer=""></script><script src="/_next/static/Be7GKARz4at19fmnu6Tej/_ssgManifest.js" defer=""></script></head><body><div id="__next"><div style="font-family:system-ui,&quot;Segoe UI&quot;,Roboto,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;;height:100vh;text-align:center;display:flex;flex-direction:column;align-items:center;justify-content:center"><div><style>body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}</style><h1 class="next-error-h1" style="display:inline-block;margin:0 20px 0 0;padding-right:23px;font-size:24px;font-weight:500;vertical-align:top;line-height:49px">404</h1><div style="display:inline-block;text-align:left"><h2 style="font-size:14px;font-weight:400;line-height:49px;margin:0">This page could not be found<!-- -->.</h2></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"statusCode":404}},"page":"/_error","query":{},"buildId":"Be7GKARz4at19fmnu6Tej","nextExport":true,"isFallback":false,"gip":true,"scriptLoader":[]}</script></body></html>

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/_next/static/chunks/nextra-data-en-US.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"/changelog/v1.0.0":{"title":"Release notes, v1.0.0","data":{"":"Stay tuned."}},"/":{"title":"🧩 Module ","data":{"":"Template for a typical module written on Go.","-quick-start#🛫 Quick start":"Work with Makefile\n$ make setup\n$ make help\n\n$ make find-todos\n$ make test lint\n$ TIMEOUT=5s make test-with-coverage\nWork with Taskfile\n$ alias run=./Taskfile\n$ run help\n\n$ run docs\n$ run docs install build start\nWork with Tools\n$ make tools\n$ source bin/activate\n\n$ which goimports\n$ make go-fmt # goimports -local $(go list -m) -w ./...\nWork with Docker\n$ make go-1.11 # or go-1.12, etc.\n/src# make go-env 2>/dev/null | grep GOVERSION\n# GOVERSION: 1.11.13\n/src# make test","-idea#💡 Idea":"Define a powerful template that quickly creates a new Go module from scratch.\nNot only does it provide a starting point for new projects,\nbut it comes equipped with pre-configured ci/cd and inventory.","-motivation#🏆 Motivation":"At OctoLab, we want to start new projects faster using best practices\nwith a predefined structure and focusing on core ideas implementation\nrather than wasting time on environment configuration and copying boilerplate code.","-how-to#🤼‍ How to":"","build-your-own-module#Build your own module":"Generate a new repository from the template.\nClone the repository locally.\nUpdate files:\ndocs/CNAME, tools/pages/*, tools/*.jsx?,\ngo.mod, and README.md:\n🛫 Quick start\n💡 Idea\n🏆 Motivation\n🤼‍ How to\n🛬 Integration\n\n\n\n\nWrite your code and tests.\n🚀","contribute-to-the-template#Contribute to the template":"Read the contribution guidelines.\nFork the repository.\nMake your changes.\nSend a pull request.\n🤗\n\nBefore you start, please make sure your changes are in demand.\nThe best for that is to create a new discussion,\nor if you find an issue, report it first.","️-configuration#🎛️ Configuration":"","pre-configured#Pre-configured":"GitHub Actions.\nGitHub Pages.\nDependabot.","included#Included":"Nextra.\nMakefiles.\nTaskfiles.\nGo tools:\nmockgen,\ngolangci-lint,\ngoimports,\ngovulncheck.","optional#Optional":"Bitbucket.\nCodecov.\nSlack.\nSettings.\nGitHub Socialify.\nGo Report Card.\nShields.io.","coming-soon#Coming soon":"CodeQL (code scanning).\nGraphite (git workflow).\nQodana (code quality).\nSonarCloud (code quality).\nVanity URL (canonical import path).\nVercel (docs preview).","miscellaneous#Miscellaneous":"Crontab.guru.\nGit History.","-integration#🛬 Integration":"The project uses SemVer for versioning, and it is not\nBC-safe through major releases.\nPlease use Go Modules to manage its version.\n$ go get go.octolab.org@latest","-outputs--outcomes#🤲 Outputs & outcomes":"OctoLab\n\nhttps://github.com/octolab/breaker*\nhttps://github.com/octolab/cli*\nhttps://github.com/octolab/config\nhttps://github.com/octolab/pkg*\nhttps://github.com/octolab/propaganda\nhttps://github.com/octolab/protocol*\n\n\n\n\nOctomation\n\nhttps://github.com/octomation/dna*\nhttps://github.com/octomation/go-tool*\nhttps://github.com/octomation/go-service*\n\n\n\n\nOthers\n\nhttps://github.com/kamilsk/retry*\nhttps://github.com/kamilsk/semaphore*\nhttps://github.com/kamilsk/tracer*\n\n\n\nmade with ❤️ for everyone"}}}
{"/changelog/v1.0.0":{"title":"Release notes, v1.0.0","data":{"":"👋 Hi, folks!We are glad to announce the first stable release of the template\nto help the Go community build their excellent modules faster! 🎉","ready-to-go#Ready to go":"Adopted for Go 1.11..1.20 support.\nCall make go-1.11 # go-1.12, etc. and work with a module inside the specified Go environment.\n\n\nHas a lot of well-tested workflows.\nUses the full power of GitHub:\nGitHub Actions.\nGitHub Pages.\nDependabot.\n\n\nImplements best practices of Go.\nIncludes Makefiles, Taskfiles, and tools.","out-of-the-box#Out of the box":"","slack-integration#Slack integration":"","documentation#Documentation":"Based on Nextra, hosted by GitHub Pages.\nSee the example."}},"/":{"title":"🧩 Module ","data":{"":"Template for a typical module written on Go.","-quick-start#🛫 Quick start":"Work with Makefile\n$ make setup\n$ make help\n\n$ make find-todos\n$ make test lint\n$ TIMEOUT=5s make test-with-coverage\nWork with Taskfile\n$ alias run=./Taskfile\n$ run help\n\n$ run docs\n$ run docs install build start\nWork with Tools\n$ make tools\n$ source bin/activate\n\n$ which goimports\n$ make go-fmt # goimports -local $(go list -m) -w ./...\nWork with Docker\n$ make go-1.11 # or go-1.12, etc.\n/src# make go-env 2>/dev/null | grep GOVERSION\n# GOVERSION: 1.11.13\n/src# make test","-idea#💡 Idea":"Define a powerful template that quickly creates a new Go module.\nNot only does it provide a starting point for new projects,\nbut it comes equipped with pre-configured ci/cd and inventory.","-motivation#🏆 Motivation":"At OctoLab, we want to start new projects faster using best practices\nwith a predefined structure and focusing on core ideas implementation\nrather than wasting time on environment configuration and copying boilerplate code.","-how-to#🤼‍ How to":"","build-your-own-module#Build your own module":"Generate a new repository from the template.\nClone the repository locally.\nUpdate files:\ndocs/CNAME, tools/pages/*, tools/*.jsx?,\ngo.mod, and README.md:\n🛫 Quick start\n💡 Idea\n🏆 Motivation\n🤼‍ How to\n🛬 Integration\n\n\n\n\nWrite your code and tests.\n🚀","contribute-to-the-template#Contribute to the template":"Read the contribution guidelines.\nFork the repository.\nMake your changes.\nSend a pull request.\n🤗\n\nBefore you start, please make sure your changes are in demand.\nThe best for that is to create a new discussion,\nor if you find an issue, report it first.","️-configuration#🎛️ Configuration":"","pre-configured#Pre-configured":"GitHub Actions.\nGitHub Pages.\nDependabot.","included#Included":"Nextra.\nMakefiles.\nTaskfiles.\nGo tools:\nmockgen,\ngolangci-lint,\ngoimports,\ngovulncheck.","optional#Optional":"Bitbucket.\nCodecov.\nSlack.\nSettings.\nGitHub Socialify.\nGo Report Card.\nShields.io.","coming-soon#Coming soon":"CodeQL (code scanning).\nGraphite (git workflow).\nQodana (code quality).\nSonarCloud (code quality).\nVanity URL (canonical import path).\nVercel (docs preview).","miscellaneous#Miscellaneous":"Crontab.guru.\nGit History.","-integration#🛬 Integration":"The project uses SemVer for versioning, and it is not\nBC-safe through major releases.\nPlease use Go Modules to manage its version.\n$ go get go.octolab.org@latest","-outputs--outcomes#🤲 Outputs & outcomes":"OctoLab\n\nhttps://github.com/octolab/breaker*\nhttps://github.com/octolab/cli*\nhttps://github.com/octolab/config\nhttps://github.com/octolab/pkg*\nhttps://github.com/octolab/propaganda\nhttps://github.com/octolab/protocol*\n\n\n\n\nOctomation\n\nhttps://github.com/octomation/dna*\nhttps://github.com/octomation/go-tool*\nhttps://github.com/octomation/go-service*\n\n\n\n\nOthers\n\nhttps://github.com/kamilsk/retry*\nhttps://github.com/kamilsk/semaphore*\nhttps://github.com/kamilsk/tracer*\n\n\n\nmade with ❤️ for everyone"}}}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit cbfd1cf

Please sign in to comment.