Skip to content

Created A Docs for Laravel MongoDB Using vitepress(my favorite doc creator) #2526

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

Closed
wants to merge 3 commits into from

Conversation

JenuelDev
Copy link

@JenuelDev JenuelDev commented Mar 23, 2023

I have been loving laravel MongoDB but I am having problems trying to navigate to the documentation in GitHub. So I started creating my own documentation and want to share it and maybe add it to the repo.

Here is the sample: https://laravel-mongodb.vercel.app/

👔 Deployment:

Deployment

I recommend deploying it on VERCEL because it has great support for the vuejs environment.
How To Deploy:

  1. Create or Login Account to Vercel.

  2. On https://vercel.com/dashboard click add new and select project.

  3. In the Import Box, select the branch you like to import.

  4. Configure Project
    Select Edit for the root directory and select docs.
    image
    And override the other command, and then click the deploy button.
    image

  5. Setup domain, by going to your project and selecting settings, and click the domain tab. This is were you set the domain name.

image

How To Edit Doc:

How To Edit Docs Page

Once The doc is merged, we can set the GitHub link on the docs config. And a link will show up like the photo below were anyone can edit and create PR. You can check this demo site to see how it works: https://laravel-mongodb.vercel.app/

This is very useful if contributors did an update, they can just go to the docs site, and update the docs easily.

image

@JenuelDev JenuelDev changed the title Created A Docs for the Website Using vitepress Created A Docs for Laravel MongoDB Using vitepress(my favorite doc creator) Mar 23, 2023
@divine
Copy link
Contributor

divine commented Mar 24, 2023

Hello,

Sadly, we don't have permission to configure this, see #2499.

Thanks!

@JenuelDev
Copy link
Author

Hello,

Sadly, we don't have permission to configure this, see #2499.

Thanks!
oh shoot,, thats sad.. what did jenseggers say?

@alcaeus
Copy link
Member

alcaeus commented Mar 24, 2023

I'd like to add that such pull requests should also come with maintainer documentation. For example, what's necessary to get this deployed? What kind of tooling must be added to ensure docs are re-generated when they change? Remember that when you're creating a pull request you're not just adding a feature, you're asking the maintainers to take care of that feature in the future. That requires knowledge which this PR does not provide.

@JenuelDev
Copy link
Author

I'd like to add that such pull requests should also come with maintainer documentation. For example, what's necessary to get this deployed? What kind of tooling must be added to ensure docs are re-generated when they change? Remember that when you're creating a pull request you're not just adding a feature, you're asking the maintainers to take care of that feature in the future. That requires knowledge which this PR does not provide.

sorry, going to re edit the description of my PR

@JenuelDev
Copy link
Author

I'd like to add that such pull requests should also come with maintainer documentation. For example, what's necessary to get this deployed? What kind of tooling must be added to ensure docs are re-generated when they change? Remember that when you're creating a pull request you're not just adding a feature, you're asking the maintainers to take care of that feature in the future. That requires knowledge which this PR does not provide.

I have now Updated the description for more information.

@divine
Copy link
Contributor

divine commented May 2, 2023

Sorry, closing it for now. Probably will be taken care in the future.

Thanks!

@divine divine closed this May 2, 2023
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.

3 participants