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

Restructure Docs #18

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open

Restructure Docs #18

wants to merge 22 commits into from

Conversation

Andre601
Copy link
Contributor

@Andre601 Andre601 commented Sep 7, 2024

Restructures the current documentation.

Things left to do:

  • Add redirects for old pages to new ones
  • Add Git Integration page content
  • Add GitLab Integration page content
  • Add BitBucket Integration page content
  • Add pages suggested in this PR

@Andre601 Andre601 marked this pull request as draft September 7, 2024 14:16
This was linked to issues Sep 8, 2024
@gmitch215 gmitch215 marked this pull request as ready for review September 9, 2024 12:43
gmitch215 and others added 2 commits September 9, 2024 08:40
Please talk with me about changes before just making them. Thanks.
@gmitch215
Copy link
Member

My apologies. I thought I tried to submit a review, not a commit...

Copy link
Member

@gmitch215 gmitch215 left a comment

Choose a reason for hiding this comment

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

70% Grammer, 30% Changes

docs/faq/adding-your-project.md Outdated Show resolved Hide resolved
docs/faq/build-jdk-8-project.md Outdated Show resolved Hide resolved
docs/faq/build-jdk-8-project.md Outdated Show resolved Hide resolved
docs/faq/non-mc-projects.md Outdated Show resolved Hide resolved
docs/services/ci/index.md Outdated Show resolved Hide resolved
docs/usage-guidelines.md Outdated Show resolved Hide resolved
docs/usage-guidelines.md Outdated Show resolved Hide resolved
docs/usage-guidelines.md Outdated Show resolved Hide resolved
docs/usage-guidelines.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
@gmitch215
Copy link
Member

Didn't edit everything else, only added the missing content from the TODO pages.

Information was borrowed from official documentation. BitBucket isn't implemented yet until @sgdc3 installs the BitBucket plugin. Feel free to directly change the files.

@gmitch215 gmitch215 self-requested a review September 24, 2024 16:11
@sgdc3
Copy link
Member

sgdc3 commented Sep 25, 2024

@gmitch215 bitbucket integration installed 👍

@Andre601
Copy link
Contributor Author

I've now set up redirects for the old pages under the /jenkins/ subpage, to allow them still working in case they have been shared in the past.

One thing that is still left is updating the commit/build status integration for GitHub, as that one uses info that by the looks of it do no longer work with the current Jenkins implementation of CodeMC. I sadly don't know what the current/new aproach would be, if there still is one.

Copy link
Member

@gmitch215 gmitch215 left a comment

Choose a reason for hiding this comment

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

If @sgdc3 has nothing else, LGTM

@Andre601
Copy link
Contributor Author

Andre601 commented Oct 2, 2024

Made some final changes on my ends now. Namely I added the git-revision-date-localized and the git-committers plugins to use.
First will add the date of a page's last edit and its creation using the git history, which is useful for pages like the usage guidelines (See image below).
Second adds avatars of the users who edited the pages using GitHub API. Found this to be a nice way to give credists to contributors. It's disabled for environments without the right env vars set (See mkdocs.yml for the ones used).

grafik

I also updated the GitHub Actions Workflow to now use a direct deployment to GitHub pages which is usually faster and better to do. It will require to save the custom subdomain again in the repo settings so GitHub is aware of it being used as the CNAME file has no usage here using this aproach.
The gh-pages branch can also be removed after this.

docs/usage-guidelines.md Outdated Show resolved Hide resolved
Copy link

cloudflare-workers-and-pages bot commented Oct 4, 2024

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 07afa18
Status: ✅  Deploy successful!
Preview URL: https://ac17c68d.documentation-cvg.pages.dev
Branch Preview URL: https://feature-restructure-docs.documentation-cvg.pages.dev

View logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Reviewed
Development

Successfully merging this pull request may close these issues.

Extended Documentation Documentation for Newer Features
3 participants