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

Create github pages deploy for javadocs #2231

Merged
merged 2 commits into from
Jun 8, 2023
Merged

Conversation

MinnDevelopment
Copy link
Member

Pull Request Etiquette

Changes

  • Internal code
  • Library interface (affecting end-user code)
  • Documentation
  • Other: _____

Closes Issue: NaN

Description

This adds a github action to deploy javadocs as github pages.

To use this the repository settings need to be updated:

  1. Open Pages Settings
  2. Set the source to GitHub Actions
    image
  3. Optionally configure a custom domain

This is one of the first steps towards independence from jenkins.

On push to master, this will deploy the updated documentation under dv8fromtheworld.github.io/JDA or on the custom domain. For example, my discord-webhooks project is hosted this way on https://minndevelopment.github.io/discord-webhooks/overview-tree.html

@Andre601
Copy link
Contributor

I think the jda.wiki domain could be utilized here. Maybe jd.jda.wiki or docs.jda.wiki would be a good option (I personally would go with first option).
Alternatively use the dv8tion domain as it is used already for the Jenkins, but with a different subdomain.

@DV8FromTheWorld
Copy link
Member

DV8FromTheWorld commented Jun 8, 2023

I like the concept of docs.jda.wiki
Is the only thing holding this back a merge and setting up the settings + domain?

Also, what happens to docs for other versions, like v4? Guess they just kinda die as we move?

@MinnDevelopment
Copy link
Member Author

We will only have docs for the current master branch with this. However, older versions are available at javadoc.io.

@DV8FromTheWorld DV8FromTheWorld merged commit e1103d9 into master Jun 8, 2023
1 check passed
@DV8FromTheWorld DV8FromTheWorld deleted the actions/docs branch June 8, 2023 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants