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

different approach for docs #370

Open
jmtd opened this issue Mar 10, 2020 · 0 comments
Open

different approach for docs #370

jmtd opened this issue Mar 10, 2020 · 0 comments

Comments

@jmtd
Copy link
Collaborator

jmtd commented Mar 10, 2020

I would like to look at a scheme where we do not commit auto-generated documentation into this repository, but instead populate a separate repository with auto-generated documentation and generate a website (github pages perhaps) from that. We could set up a CI to automate the process. Travis CI or whatever.

jmtd added a commit to jmtd/cct_module that referenced this issue Mar 18, 2020
As mentioned in jboss-openshift#370, we need a different approach for docs. These
files get stale as the modules are updated but they are not regenerated,
and they make refactoring work very difficult.

We can either come up with a new scheme or re-introduce these later on.

Signed-off-by: Jonathan Dowland <[email protected]>
jmtd added a commit that referenced this issue Mar 18, 2020
As mentioned in #370, we need a different approach for docs. These
files get stale as the modules are updated but they are not regenerated,
and they make refactoring work very difficult.

We can either come up with a new scheme or re-introduce these later on.

Signed-off-by: Jonathan Dowland <[email protected]>
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

1 participant