Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to Read the Docs for Business docs from relevant sections #6004

Merged
merged 2 commits into from Jul 31, 2019

Conversation

@davidfischer
Copy link
Contributor

@davidfischer davidfischer commented Jul 27, 2019

  • This PR exclusively updates docs
  • Link to the RTD for Business docs from relevant pages (eg. "Need commercial support? See RTD.com")
  • I did only a very minor update to the privacy levels docs which probably need a more major overhaul to explain what RTD for Business offers there relative to the community site. This is on the roadmap already, I believe.
@davidfischer davidfischer requested a review from Jul 27, 2019
Copy link
Member

@humitos humitos left a comment

Looks good! I left some notes.

@@ -14,6 +14,9 @@ Our current build limits are:

We can increase build limits on a per-project basis,
sending an email to support@readthedocs.org providing a good reason why your documentation needs more resources.
If your business is hitting build limits hosting documentation on Read the Docs,
Copy link
Member

@humitos humitos Jul 29, 2019

This is tricky to me. I mean, "if you have a business, you should not be using .org" I understand.

Although, maybe business has a more expand meaning and I'm not getting it. I immediately related it to company, so.

Copy link
Contributor Author

@davidfischer davidfischer Jul 31, 2019

Well, I think the bigger issue here is businesses asking for free support (additional resources, specific issues in the issue tracker, etc.) for running their critical business processes. If they want that support, there's a way to get it: paid plans. For a business that is just using Read the Docs and doesn't really need anything, have at it!


.. _commercial hosting: https://readthedocs.com
.. note:: These directions are for projects hosted on our community site.
If you want to setup a custom domain on `Read the Docs for Business <https://readthedocs.com/>`_,
Copy link
Member

@humitos humitos Jul 29, 2019

Sometimes we link "Read the Docs for Business" to readthedocs.com and some others to <commercial/index>. Is that on purpose?

Copy link
Contributor Author

@davidfischer davidfischer Jul 31, 2019

In general, I tried to link directly to readthedocs.com from subpages of commercial and linked to commercial/index on other pages. This page was the only special one where I linked to both (actually it already did that).

Copy link
Contributor

@agjohnson agjohnson left a comment

Changes look really good.

One addition that might make sense to play with here would be to use the sphinx_tabs extension. I think we talked earlier about using sphinx_tabs extension to house .org/.com competing content on the same doc page. I liked this idea as it gives a more direct up sell to users looking at community docs, and it doesn't require authoring multiple pages -- which so far has been the pain point in our docs.

For now, I think custom domains is the only really strong place where this deviates, but we should eventually be documenting more of our UI and admin functions in our docs as well.


.. warning::
Read the Docs developers do not support custom installs of our software.
These documents are maintained by the community, and might not be up to date.
Copy link
Contributor

@agjohnson agjohnson Jul 29, 2019

We probably already link to our policy on open source and support of custom installs, but this could be a good place to re-iterate.

Copy link
Contributor Author

@davidfischer davidfischer Jul 31, 2019

You're talking about this, correct? https://readthedocs.com/services/#open-source-support

Copy link
Contributor Author

@davidfischer davidfischer Jul 31, 2019

I added a link to that.

@@ -1,12 +1,16 @@
Custom Domains
==============

.. note:: These directions are for projects hosted on Read the Docs for Business.
For setting up a custom domain on a project hosted on readthedocs.org,
please read our :doc:`community documentation </custom_domains>`.
Copy link
Contributor

@agjohnson agjohnson Jul 29, 2019

Instead of a separate page for these docs, the feature we discussed adding with this PR is to use sphinx_tabs extension to make it really easy to click between .org and .com directions for areas where docs deviated. This seems like a more digestible pattern for the reader. Do we want to address that now?

Copy link
Contributor Author

@davidfischer davidfischer Jul 31, 2019

I think that's a separate issue. This PR is purely marketing as opposed to actually editing much in the way of documentation and merging two docs into one.

@davidfischer
Copy link
Contributor Author

@davidfischer davidfischer commented Jul 31, 2019

One addition that might make sense to play with here would be to use the sphinx_tabs extension. I think we talked earlier about using sphinx_tabs extension to house .org/.com competing content on the same doc page.

I'm on board with this, but this PR is purely marketing changes. I think that's a separate PR.

@davidfischer davidfischer merged commit eaae969 into master Jul 31, 2019
2 checks passed
@delete-merged-branch delete-merged-branch bot deleted the davidfischer/commercial-docs-links branch Jul 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants