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

Migrate website/documentation into main git repo #2333

Closed
abrokenjester opened this issue Jun 24, 2020 · 3 comments · Fixed by #2389 or #2394
Closed

Migrate website/documentation into main git repo #2333

abrokenjester opened this issue Jun 24, 2020 · 3 comments · Fixed by #2389 or #2394
Assignees
Labels
🔧 internal task a project workflow / setup task not directly impacting end users website / documentation Website update / Documentation issue

Comments

@abrokenjester
Copy link
Contributor

We currently have a separate git repository for the website and documentation. This makes it somewhat difficult to keep track of whether or not new features have been properly documented, which issues changes to the website/documentation belong to, etc.

I'd like to propose that we move the rdf4j-doc contents into the main git repository, so that code changes and accompanying documentation changes can be solved in the same pull request if we want. It will also make updating the published javadoc easier.

@abrokenjester abrokenjester added 💬 needs discussion website / documentation Website update / Documentation issue 🔧 internal task a project workflow / setup task not directly impacting end users labels Jun 24, 2020
@github-actions github-actions bot added this to 📥 Inbox in Project Progress Jun 24, 2020
@abrokenjester abrokenjester self-assigned this Jun 25, 2020
@abrokenjester abrokenjester moved this from 📥 Inbox to 📋 Backlog in Project Progress Jun 25, 2020
@abrokenjester
Copy link
Contributor Author

One thing I haven't fully figured out yet is how we handle (continuous) deployment of the website in a single repo. Currently, the website is deployed straight from the master branch (the website host server runs a git pull and a site build on a regular schedule), but if we start handling things in a single repo, we don't (always) want documentation updates for things that haven't yet been released.

Though perhaps, if master is always used for bug fixes only (including "bug fixes" in the website/documentation) this isn't a big deal.

@abrokenjester
Copy link
Contributor Author

Scheduled to start on this after the 3.3.0 release, to minimize the number of parallel branches I will have to transport.

@abrokenjester abrokenjester moved this from 📋 Backlog to 🚧 In progress in Project Progress Jul 25, 2020
Project Progress automation moved this from 🚧 In progress to 🥳 Done Jul 26, 2020
abrokenjester added a commit that referenced this issue Jul 26, 2020
@abrokenjester abrokenjester moved this from 🥳 Done to 🚧 In progress in Project Progress Jul 26, 2020
@abrokenjester abrokenjester reopened this Jul 26, 2020
@abrokenjester
Copy link
Contributor Author

Main branch merged. Website server reconfigured to use the main rdf4j repo to generate the site. We're migrated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔧 internal task a project workflow / setup task not directly impacting end users website / documentation Website update / Documentation issue
Projects
No open projects
1 participant