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

Enhance documentation #362

Closed
multiverseweb opened this issue Jan 6, 2025 · 10 comments · Fixed by #365
Closed

Enhance documentation #362

multiverseweb opened this issue Jan 6, 2025 · 10 comments · Fixed by #365
Assignees
Labels
documentation Improvements or additions to documentation INTERMEDIATE SWOC

Comments

@multiverseweb
Copy link
Owner

Add a section in the contributing.md file, informing contributors about the port to open in their browser.

The website can be accessed by opening

http://localhost:2604/

in the browser.

Also, add

{
    "liveServer.settings.CORS": true
}

to the .vscode/settings.json file to deal with the CORS errors.

@github-actions github-actions bot added the Review Queued Waiting for the Dataverse's Maintainer to review this issue. label Jan 6, 2025
@multiverseweb multiverseweb added documentation Improvements or additions to documentation SWOC INTERMEDIATE and removed Review Queued Waiting for the Dataverse's Maintainer to review this issue. labels Jan 6, 2025
@multiverseweb
Copy link
Owner Author

@Rucha-Ambaliya would you like to work on this issue?

@Rucha-Ambaliya
Copy link
Contributor

Rucha-Ambaliya commented Jan 7, 2025

Yes, I'm up for it! Thank you so much for the detailed guide on how to solve it!

@Rucha-Ambaliya
Copy link
Contributor

Rucha-Ambaliya commented Jan 7, 2025

@multiverseweb
I have a few questions:

  1. Without instructions for installing "Go Live," how will the port work?

  2. If you meant adding a URL and not GUI instructions, the URL should be http://localhost:2604/Dataverse/index.html.

  3. Despite changing the port to 2604 in .vscode/settings.json, Go Live still defaults to port 5500 and doesn’t work:

    {
      "liveServer.settings.port": 2604,
      "liveServer.settings.CORS": false,
      "_comment": "🎁🏙🚀"
    }
  4. Should I leave it as port 5500 and add the URL http://localhost:5500/Dataverse/index.html in the documentation?

  5. CORS errors occur because it blocks URLs like this: file:///C:/.../Dataverse/index.html. If we use Go Live, this won't be an issue. Should I still add "liveServer.settings.CORS": true, to the configuration?

@Bishal-35
Copy link

Hey @multiverseweb I would like to work on the issue. Please assign me

@multiverseweb
Copy link
Owner Author

Okay @Rucha-Ambaliya, now I understood the issue. Thanks for the clarification.

@multiverseweb
Copy link
Owner Author

Hey @Bishal-35, Rucha has been working on this issue already, you can work on #301. Thanks for understanding!

@Rucha-Ambaliya
Copy link
Contributor

Okay, I'll add it by tonight! Also, I had a small question — is there any Discord server for Dataverse open-source contribution? If so, I'd love to join it!

@multiverseweb
Copy link
Owner Author

Hey @Rucha-Ambaliya, there is a discord channel for dataverse dedicated to SWOC named #dataverse. You can find in in this server.
Other than this, I have created a discord server for @Multiverse-Web, I'm building this community to connect people working in STEM fields. We will be creating several innovative projects and exploring stuff together. Here's the link to server, it will be active before SWOC ends.

@Rucha-Ambaliya
Copy link
Contributor

Thank you for sharing them! I will join both the discords!

@multiverseweb
Copy link
Owner Author

That's really nice @Rucha-Ambaliya, looking forward to collaborating more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation INTERMEDIATE SWOC
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants