Skip to content

Improve ability to test forks #10

Open
@sharmaeklavya2

Description

@sharmaeklavya2

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.

Activity

svaderia

svaderia commented on Jun 1, 2018

@svaderia
Member

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

sharmaeklavya2 commented on Jun 1, 2018

@sharmaeklavya2
MemberAuthor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    Improve ability to test forks · Issue #10 · bitsacm/bitsacm.github.io