blog
blog copied to clipboard
readthedocs
Blog post about "shot-scraper"
We tweeted about shot-scraper at https://twitter.com/readthedocs/status/1582763564376690689
It would be good to write a small blog post showing a real good use case. I was thinking that the blog post could use "Adding a custom domain on a Read the Docs project" as an example, where it documents the process and shows screenshots of the dashboard UI while explaining it.
- Blog post: https://simonwillison.net/2022/Oct/14/automating-screenshots/
- Documentation: https://shot-scraper.datasette.io/en/stable/
Do we need to invent a use-case or..... ta-daaaaaa: a self-contained EXAMPLE PROJECT that has a website and automatically creates screenshots for its own documentation in every PR build? :)
Alternatives to "own website" in order to just have "pretty" screenshots
I was thinking that we could copy a "Creative Commons" licensed Bootstrap theme to quickly setup some website? https://www.bootstrapdash.com/product-category/free-bootstrap-admin-templates/creative-commons-license
There are also some Dashboard examples that AFAICT are free, for instance this one: https://modularcode.io/modular-admin-html/
Or we just reach out to a company and ask for permission to use screenshots of their demo (since it gives exposure)? I.e. https://colorlib.com/polygon/concept/index.html
IMHO, that sounds like a ton of work for a simple blog post.
We don't have to invent a use-case. I've already propose one that it's real: "How to create a Custom Domain on Read the Docs". We also have the website online to take screenshots from. Besides, it also promotes one of our features and how easy it is to create a custom domain on Read the Docs.
@humitos that sounds great! I had my mind on an example project, nothing more than that really. The case of grabbing screenshots of a running website or application is very interesting because it really pushes the boundaries of "Documentation CI". But definitely, it will scope creep, so I can save it for a hobby project :)
Do you want to write the blog post?
~On a less related note: This is an important reminder of why we need good redirects when we reorganize our documentation. A blog post example like this one, using specific pages in our documentation should not break 1 months down the road.~ Our blog has intersphinx so we can fix old blog posts instead :smile:
Do you want to write the blog post?
I don't have a strong preference. Either way is fine.
