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

REF: setup libseccomp documentation on Read the Docs #195

Open
pcmoore opened this issue Dec 6, 2019 · 9 comments · May be fixed by #366
Open

REF: setup libseccomp documentation on Read the Docs #195

pcmoore opened this issue Dec 6, 2019 · 9 comments · May be fixed by #366

Comments

@pcmoore
Copy link
Member

pcmoore commented Dec 6, 2019

It might be nice to look into hosting some of the libseccomp documentation on Read the Docs; at the very least a short into into the project and the info from the manpages.

However we do this, it should be automated. I do not want to have to maintain multiple sets of documentation; the Read the Docs documentation should pull from either the manpages or doxygen style comments in the code.

@pcmoore
Copy link
Member Author

pcmoore commented Dec 6, 2019

Related: #83.

@pcmoore pcmoore added this to the v2.6 milestone Mar 19, 2020
@oxr463
Copy link

oxr463 commented Apr 10, 2020

You could also use GitHub Pages for this. Either way, let me know and I can knock it out pretty quick.

@oxr463
Copy link

oxr463 commented Apr 10, 2020

Read the Docs URL: https://libseccomp.readthedocs.io/en/latest/
Read the Docs Project URL: https://readthedocs.org/projects/libseccomp/

The project libseccomp doesn't have a valid webhook set up, commits won't trigger new builds for this project. See the project integrations for more information.

This needs to be owned by a GitHub Project maintainer.

Also, we can use Mkdocs for generating the docs using markdown, instead of reStructuredText and Sphinx.

@oxr463

This comment has been minimized.

@pcmoore
Copy link
Member Author

pcmoore commented Apr 13, 2020

Hi @oxr463, I'm really happy to see you jumping in to help with the documentation - that is very good news! Right now we're trying to stay focused on getting v2.5.0 released, but I will definitely take you up your offer to help if you don't mind waiting a bit?

@pcmoore pcmoore linked a pull request Apr 13, 2020 that will close this issue
2 tasks
@oxr463
Copy link

oxr463 commented May 10, 2021

Hi @oxr463, I'm really happy to see you jumping in to help with the documentation - that is very good news! Right now we're trying to stay focused on getting v2.5.0 released, but I will definitely take you up your offer to help if you don't mind waiting a bit?

Hi there! Do you have any bandwidth for this now? See PR for latest updates.

@drakenclimber drakenclimber linked a pull request Jan 14, 2022 that will close this issue
@drakenclimber drakenclimber linked a pull request Jan 14, 2022 that will close this issue
@pcmoore
Copy link
Member Author

pcmoore commented Jan 7, 2024

In an effort to get v2.6.0 out sooner than later, I'm going to suggest we push this out to v2.7.0; if you have any concerns or objections please drop a comment.

@pcmoore pcmoore modified the milestones: v2.6.0, v2.7.0 Jan 7, 2024
@oxr463
Copy link

oxr463 commented Jan 7, 2024

@pcmoore yay! Looks like this might be getting priority judging from the milestone change. Let me know if you need any help getting this setup.

@pcmoore
Copy link
Member Author

pcmoore commented Jan 8, 2024

Hi @oxr463, unfortunately it is just the opposite, I'm suggesting we move this from the v2.6.0 release to the v2.7.0 release as no real progress has been made on this recently. However, the good news is that external documentation changes like this can be easily done outside major/minor release cycles.

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