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

type documentation and links to other resources #66

Open
4nd3r opened this issue Jan 24, 2022 · 2 comments
Open

type documentation and links to other resources #66

4nd3r opened this issue Jan 24, 2022 · 2 comments

Comments

@4nd3r
Copy link
Member

4nd3r commented Jan 24, 2022

Since we already have few changes in type documentation, some effort should put into generating cdist-community documentation somewhere. Maintaining separate homepage for now feels like too much effort, but maybe GitHub pages would work for us?

By "other resources" I mean whatever internet has to say about cdist, including ungleich's documentation etc.

Writing good documentation is hard, but at least we have something to start with.

@fancsali
Copy link
Contributor

fancsali commented Apr 8, 2022

If we can have GitHub pages set up, we can simply run an action with GitHub Actions to dump the docs whenever there's a commit to main, or a new release tag.

Alternatively we can do the same with readthedocs.io.

@sideeffect42
Copy link
Member

I think we should postpone this until we have decided for the final name of the project.

@4nd3r 4nd3r transferred this issue from skonfig/.github Mar 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants