readthedocs / blog

Read the Docs blog
https://blog.readthedocs.com
18 stars 47 forks source link

Blog Post for Autobuild docs for Pull Requests #72

Closed saadmk11 closed 5 years ago

saadmk11 commented 5 years ago

One of the biggest things to highlight though is how users can start using it! Is it just on for their project already? Do they need to do anything? Let's be really clear there. That's how you'll get feedback!

@davidfischer We will most probably deploy this behind a feature flag initially. So, Should we tell the users to ask us to enable this? Otherwise they don't need anything to Get Started as only opening a pull request will build their docs there is no initial setup needed.

davidfischer commented 5 years ago

If it's behind a feature flag, then I say we should do something like "email us to take part in the beta" or something like that.

saadmk11 commented 5 years ago

@davidfischer Updated the PR. let me know if we can add anything else like screenshots or something :)

davidfischer commented 5 years ago

I would definitely add a screenshot! Pictures can really tell the story.

safwanrahman commented 5 years ago

The blog post looks awesome. Thanks a lot @saadmk11 Can you add some future improvements of this feature if possible?

saadmk11 commented 5 years ago

Sure. I'll try my best to add more improvements in the future. :)

safwanrahman commented 5 years ago

@saadmk11 I meant Can you include the future improvement scope in the blog post?

saadmk11 commented 5 years ago

We should also reference an issue where users can comment to turn this feature on for their projects in the getting started section before we merge it.

saadmk11 commented 5 years ago

@ericholscher Updated the PR :)

ericholscher commented 5 years ago

@saadmk11 Whole lot of new editor files that need to be removed.

saadmk11 commented 5 years ago

@ericholscher Done! Sorry! Accidentally pushed that :(

ericholscher commented 5 years ago

Will plan to merge this tomorrow.

saadmk11 commented 5 years ago

@ericholscher Added some minor changes.

ericholscher commented 5 years ago

👍