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

Implement GitHub page for docs #1312

Merged
merged 13 commits into from
Dec 7, 2024
Merged

Conversation

gpibarra
Copy link
Contributor

@gpibarra gpibarra commented Oct 14, 2024

Enable Github Pages Build for Documentation


In your repository's settings under "Pages" menu item, select "GitHub Actions" in "Build and deployment > Source".

Push your changes to the main branch and wait for the GitHub Actions workflow to complete. You should see your site deployed to https://.github.io/[repository]/ or https:/// depending on your settings. Your site will automatically be deployed on every push to the main branch.

More details
VitePress - Github Pages


View result doc

@dfsmania
Copy link
Collaborator

@gpibarra Thanks for this, give me some time to familiarize with this tool and update the .gitattributes so the docs folder is not exported when installing the package with composer.

@dfsmania dfsmania marked this pull request as draft October 14, 2024 16:07
@dfsmania
Copy link
Collaborator

@resslinger What do you think about this?
We can tune this PR to have the documentation again versioned with the source code (inside docs folder) and then deployed on Github pages with the Vitepress tool (looks nice). Also, wiki pages may be dropped to avoid maintaining two copies of documentation. This will also allows for PRs to improve documentation...

@dfsmania dfsmania changed the title GitHub page doc Implement GitHub page for docs Nov 20, 2024
@dfsmania dfsmania marked this pull request as ready for review November 22, 2024 15:23
@dfsmania
Copy link
Collaborator

@gpibarra I worked some time on this, and now is ready to go, some questions first:

What will be the address of the site holding the online docs? I guess it will be published on the github pages of jeroennoten user. In that case any permission or configuration is required from this user for this to work?

@gpibarra
Copy link
Contributor Author

the url will be https://<username>.github.io/[repository]/ i.e. https://jeroennoten.github.io/[Laravel-AdminLTE/.

The user jeroennoten (I assume someone with permissions on the repository will also be able to do this) is required to configure as the documentation says:

In your repository's settings under "Pages" menu item, select "GitHub Actions" in "Build and deployment > Source".

vite press doc

@dfsmania
Copy link
Collaborator

@gpibarra OK, I do not have admin access on this repo. @jeroennoten could you please perform the previous mentioned task on the repo, or allow me for admin access in this repo?

@dfsmania
Copy link
Collaborator

@gpibarra The owner of this package didn't answer to my request (I mailed him without getting an answer too). What do you think if we move the documentation to another new repository (I can create one for this under my user namespace if you agree)?

@dfsmania dfsmania marked this pull request as draft November 30, 2024 14:09
@gpibarra
Copy link
Contributor Author

I think that's ok. It would be a shame if the repository were abandoned. In any case, if the owner is not going to be able to continue providing support, he should give you administration permissions on the repository.

@dfsmania
Copy link
Collaborator

dfsmania commented Dec 7, 2024

@gpibarra I finally managed to contact with the owner, unfortunately there's no way to give me admin access on this repository, there's no such thing on Github for personal repositories, but the owner changed the configuration as required, so let's try this out...

@dfsmania dfsmania marked this pull request as ready for review December 7, 2024 15:55
@dfsmania dfsmania merged commit e2b21cc into jeroennoten:master Dec 7, 2024
34 checks passed
@gpibarra
Copy link
Contributor Author

gpibarra commented Dec 7, 2024

It works!!! Thanks for the management!

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.

2 participants