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

Add Contributor Covenant Code of Conduct #1651

Merged

Conversation

aucampia
Copy link
Member

@aucampia aucampia commented Jan 8, 2022

Add Contributor Covenant Code of Conduct

This is prompted by @westurner's comments on rdflib-dev.

The code of conduct is added as markdown so that GitHub recognizes it
(see community/community#9442).

Also:

  • Add myst-parser in docs extras so that we can compile the code of
    conduct into docs.

This is prompted by @westurner's comments on [rdflib-dev](https://groups.google.com/g/rdflib-dev/c/mdd7rxL9_8I).

The code of conduct is added as markdown so that GitHub recognizes it
(see community/community#9442).

Also:

 - Add myst-parser in docs extras so that we can compile the code of
   conduct into docs.
@aucampia aucampia force-pushed the iwana-20211230T2020-code_of_conduct branch from 0388dee to 61d82a6 Compare January 8, 2022 13:44
@aucampia
Copy link
Member Author

aucampia commented Jan 8, 2022

Open to moving the page, GitHub recognizes it in any of the following locations:

.github/CODE_OF_CONDUCT.md
docs/CODE_OF_CONDUCT.md
CODE_OF_CONDUCT.md

I can easily convert it to rst, but the problem is that GitHub does not recognize it as a code of conduct.

I'm also open to not adding myst-parser - and not including it in docs, then it would be best to rename it docs/CODE_OF_CONDUCT.md -> CODE_OF_CONDUCT.md

@aucampia
Copy link
Member Author

aucampia commented Jan 8, 2022

Tried various things to make previews available, nothing works well, so here are screenshots:

screencapture-127-0-0-1-8080-2022-01-08-15_01_35

screencapture-127-0-0-1-8080-CODE-OF-CONDUCT-html-2022-01-08-15_01_45

@aucampia aucampia marked this pull request as ready for review January 8, 2022 14:04
Copy link
Member

@nicholascar nicholascar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with it as-is being recodnised in GitHub and translated across into docs!

@nicholascar
Copy link
Member

I don't think we will get additional reviews so merging...

@nicholascar nicholascar merged commit c0bd5ea into RDFLib:master Jan 15, 2022
@westurner
Copy link
Contributor

Nice work

Hadn't realized you can just add Myst-parser to extras. JupyterBook (possibly with JupyterLite) is now supported on rtd: https://blog.readthedocs.com/jupyter-book-read-the-docs/

How to deploy a Jupyter Book project to Read the Docs

With the current development version of Jupyter Book, you can now export a Sphinx conf.py configuration from the Jupyter Book declarative _config.yml and save it to disk, which allows Read the Docs to build the documentation from it like any other Sphinx project.

The challenge then becomes keeping both configuration files synchronized, since every update to _config.yml or new Jupyter Book release can potentially produce changes in the conf.py. As described in the official documentation, users can either manually export the configuration running a command at will, or set up an automation to do it on every change.

To see this in action, have a look at this example project that contains the bare minimum to make the demo book work on Read the Docs.

https://github.com/astrojuanlu/jupyterbook-on-read-the-docs


JupyterLite

@aucampia aucampia deleted the iwana-20211230T2020-code_of_conduct branch April 9, 2022 14:15
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

Successfully merging this pull request may close these issues.

None yet

3 participants