search

luc-github / ESP3D

FW for ESP8266/ESP8285/ESP32 used with 3D printer
GNU General Public License v3.0
1.74k stars 465 forks source link

[BUG]Some Wiki images are broken #512

Closed luc-github closed 3 years ago

luc-github commented 3 years ago

Some of the wiki images links are broken - I am guessing it is due to main branch is now changed

I will work on new wiki solution to avoid such issue

luc-github commented 3 years ago

some external links are also broken image

and I am wondering if any images in issue tracker could also be lost in some way if github do some cleaning

luc-github commented 3 years ago

doing a wiki branch with all data wiki page + images will secure this from another point of view doing PR process will loose some flexibility and ease of use of editing WiKi

EDIT: no need a dedicated branch - images which are sync with wiki directory can be called using wiki path so path will always be valid from any branch the PR come from e.g : https://raw.githubusercontent.com/wiki/luc-github/ESP32SSDP/images/sample.png

Any comment on this ?

DivingDuck commented 3 years ago

It's always the same conflict between active development and documentation of a released version. There is no best way I think. Maybe having a development wiki separated from a relased version is a good choice. Then you have something to use as documentation for the development (like you do since quite a while as an "issue document") and when a function/feature is ready for a "productive release version" move this part of documentation to the productive wiki version. This can help to kind of develop a documentation in an early phase. Updating it further during the implementation phase like a workbook is so much easier and result in a semi finished document that is already available and need maybe only a last fine tuning.

luc-github commented 3 years ago

I am not good at documentation and to be honest not really willing to spend time to improve because most of people do not read it ... On another project I have a simple read me for installation - always up to date with code, because installation need strict actions to success or you have very specific error that is also described in read me and in FAQ => 90% people do not even check read me / FAQ but follow outdated videos on youtube and come back to github complaining it is not working due to the installation error.

That is why I was thinking for ESP3D 3.0 to use youtube videos instead of writing docs / doing screenshots etc.... but this is another topic

In my idea, the current wiki is more for people looking for the setup they need, because too many printer boards and configurations right now. so people who want to share their working setup, can help new comers wondering if it will working on their configuration, and how to succeed. I cannot do this because I do not have all hardware, that is why this is comunity effort which was good until now IMHO

I want to be sure information is not lost due to broken links and community able to update it - but github wiki is lack of file upload feature which lead to several files locations, leading to current situation of broken links.

I think I will go to github-action to sync wiki repository which will include all images and related docs - we will loose some edition ease of use but will be sure information is always there and as wiki will follow the production branch it will be always available for futur old versions also

luc-github commented 3 years ago

@crispycritter911 do you still have the image you uploaded in https://github.com/luc-github/ESP3D/wiki/Wanhao-D6---MonoPrice-Maker-Ultimate ? your link is dead - please prove the image here or do a PR to update the wiki - thank you

luc-github commented 3 years ago

@jayjojayson do you mind if I move the 2 images for https://github.com/luc-github/ESP3D/wiki/D1-mini from your repo to wiki directory ? thank you

luc-github commented 3 years ago

wiki is now sync with wiki directory, links should be fixed - just waiting for @crispycritter911 and @jayjojayson feedback to close topic

if I missed any link feel free to raise up 😅

luc-github commented 3 years ago

if no update I close topic - feel free to raise / PR missing images

github-actions[bot] commented 3 years ago

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.