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

Setup docs to avoid bloating README #247

Closed
mfridman opened this issue Mar 7, 2021 · 7 comments
Closed

Setup docs to avoid bloating README #247

mfridman opened this issue Mar 7, 2021 · 7 comments
Assignees

Comments

@mfridman
Copy link
Collaborator

mfridman commented Mar 7, 2021

I like this docs theme which works well with hugo.

https://getdoks.org/

@mfridman mfridman self-assigned this Jul 30, 2021
@mfridman
Copy link
Collaborator Author

Other alternatives are:

Going to evaluate some of these and send a PR. It'll be nice to have docs for goose to document:

  • commands
  • gotchas
  • FAQ
  • examples

@mfridman
Copy link
Collaborator Author

mfridman commented Aug 1, 2021

Tentatively setting up mkdocs - material. It's the easiest solution, looks great, is extensible, and has a good lighthouse score:

Docs found here (WIP): http://pressly.github.io/goose/

CleanShot 2021-07-31 at 21 53 09@2x

@VojtechVitek I have limited access to Settings. Can you flip the HTTPS?

https://docs.github.com/en/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https#enforcing-https-for-your-github-pages-site

@mfridman
Copy link
Collaborator Author

Add this example to docs. #176

@mfridman
Copy link
Collaborator Author

Add this answer to the docs. Mention it is specific to postgres:

#191 (comment)

@VojtechVitek
Copy link
Collaborator

@mfridman I'm sorry, first time I see these comments. Can you reach out on Golang Slack please?

@mfridman
Copy link
Collaborator Author

All good @VojtechVitek , asynchronous works 😄

The reason for a separate docs site is to capture the long-form items we've come across. I get asked about certain goose features and best practices, so just want to point at something.

@mfridman
Copy link
Collaborator Author

This is done. docs are live and can be found here...

https://pressly.github.io/goose/

wip, but we're iterating :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants