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

Improve ability to test forks #10

Open
sharmaeklavya2 opened this issue May 31, 2018 · 2 comments
Open

Improve ability to test forks #10

sharmaeklavya2 opened this issue May 31, 2018 · 2 comments
Assignees

Comments

@sharmaeklavya2
Copy link
Member

I made a few changes to a page and I wanted to test my changes.

I don't have jekyll installed, so I though of pushing changes to my own fork and viewing the github-rendered version. This works well when viewing the website at https://bitsacm.github.io/, but doesn't work as expected when viewing it at https://sharmaeklavya2.github.io/bitsacm.github.io/, because all URLs are relative to sharmaeklavya2.github.io instead of being relative to sharmaeklavya2.github.io/bitsacm.github.io.

Please fix this if you can. Maybe you can make URLs relative to current page instead of being relative to root.

I think you should also include instructions on how to test changes in the project's readme.

@svaderia
Copy link
Member

svaderia commented Jun 1, 2018

Afaik, Jekyll fetches all the relative references used in any URL from _config.yml .
There has to be some way to address this. @rohitrajhans and @MananAgarwal look into it.

@sharmaeklavya2 : By instructions, do you mean instructions for testing it offline (e.g. installing jekyll and run some commands to make local server) ?

@sharmaeklavya2
Copy link
Member Author

Contributors should be able to test their changes. There are 2 ways that come to mind:

  1. Locally: Installing Jekyll and running commands.
    2: Remotely: Pushing changes to fork's master and viewing the github-rendered version.

I think both ways are okay. You should include instructions for any one (or both) of these ways. You can also put links to other tutorials on Jekyll or github-pages; no need to paraphrase everything here.

Even if you only include instructions for local testing, you might still want to fix the issue that testing on forks is difficult.

This was referenced Jun 6, 2018
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

No branches or pull requests

3 participants