Freshrss: GH link to contributing doc 404s, Website link to same downloads .md

Created on 29 Mar 2020  路  12Comments  路  Source: FreshRSS/FreshRSS

On the main GH project page when you're excited to see how to contribute and click on the Contributor guidelines link under Documentation it goes to https://freshrss.github.io/FreshRSS/en/contributing.html. This page 404s.

Related is that when you're on the English documentation page and click on Contributor guidelines it goes to https://freshrss.github.io/FreshRSS/en/contributing.md which can't be viewed, so for me my browser attempts to download the .md file.

I think these are related and could be fixed by ensuring the .html version that works instead of the .md version. Though...I don't quite know how github.io pages work - shouldn't the .html version already work?

Documentation

All 12 comments

If this can be fixed by a non-member of the project like me, I'll be happy to try and fix it! However, I think that this is some sort of GH issue which you need to kick the .io site build process to restart or something.

The site build process is automatically initiated by a commit to master. All you need to do is change the link in the file.

Thanks @Frenzie ! I'll submit a PR with a link to the .html shortly then!

Oh, but hold on. In this case it may just be something in the Page builder action that's misconfigured.

Edit: pinging @Alkarex since I don't have sufficient permissions to check.

@Frenzie - oh - all good! I'll wait to hear back from Alkarex.

Well, besides the incorrect link to .md anyway. ;-)

Right, so changing the link from .md to .html should just fix it? I dunno as I don't ever work with github.io pages. Lemme know! Or I wait to hear back from Alkarex. Or both!

Related to https://github.com/FreshRSS/FreshRSS/pull/2685#issuecomment-558231186
Hum @Frenzie , we are using the default GitHub pages, so there should not be much special to configure:

image

I am wondering maybe whether there might be something special with the name contributing.md

oh - cool! Good to know if I bump into this on another project.

@Frenzie Isn't it easier just to give another name to the file?

\o/ it all works now - thanks you two!

Was this page helpful?
0 / 5 - 0 ratings