search

techno-tim / launchpad

A collection of quick starters for ansible, kubernetes, docker, linux, windows, and more. Great for HomeLabs!
https://technotim.live
1.48k stars 478 forks source link

"HERE" Links in your README.md is bad practice #45

Open antofthy opened 1 year ago

antofthy commented 1 year ago

Using "here" links in any document is regarded as very bad practice....

Usability & Web Accessibility - Link Text

Why Your Links Should Never Say “Click Here”

There are LOTS more such pages all over the net.

Also when writing a README you should write it as if a 'random person' just came across for the first time. You may know what you are looking at, they may not! Do not assume they are coming from your video.

Making this your "README.md" will make it a lot better...

# Linux Desktop, in a container, in a browser?  A Webtop

An example compose file to complement a YouTube Video on webtops in a container.

[Youtube Video](https://www.youtube.com/watch?v=Gd9bvdkIXOQ)

[Webtop Documentation](https://docs.technotim.live/posts/webtop-container/)
timothystewart6 commented 1 year ago

Thanks for the feedback! PRs are welcomed!