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

Add a page about choosing between .com/.org #7068

Merged
merged 8 commits into from May 14, 2020
Merged

Conversation

ericholscher
Copy link
Member

This is an initial attempt,
but I think it’s important to document this.
We get a lot of questions so it seems obvious we need to explain it better.

This is an initial attempt,
but I think it’s important to document this.
We get a lot of questions so it seems obvious we need to explain it better.
docs/index.rst Outdated
@@ -45,6 +45,7 @@ to help you create fantastic documentation for your project.
:doc:`With Sphinx </intro/getting-started-with-sphinx>` |
:doc:`With MkDocs </intro/getting-started-with-mkdocs>` |
:doc:`Feature Overview </features>`
:doc:`Choosing between our two sites </choosing-a-site>`
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what to call these, really. It likely needs to be more explicit.

@ericholscher ericholscher requested a review from a team May 12, 2020
docs/choosing-a-site.rst Show resolved Hide resolved
docs/choosing-a-site.rst Show resolved Hide resolved
docs/choosing-a-site.rst Outdated Show resolved Hide resolved
docs/choosing-a-site.rst Outdated Show resolved Hide resolved
stsewd
stsewd approved these changes May 12, 2020
@ericholscher ericholscher requested a review from agjohnson May 12, 2020
Copy link
Contributor

@davidfischer davidfischer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a bit of overlap (but not complete overlap) between this new page and https://docs.readthedocs.io/en/stable/commercial/index.html.

I'm also not sold that the getting started section that talks about the very first steps with Sphinx and MkDocs is the right place for this. I'm all for putting a bit of a sales pitch into the docs though. Perhaps on the front page of the docs after the sentence "You can find out more about our all the Read the Docs features in these pages."?

docs/index.rst Outdated Show resolved Hide resolved
ericholscher and others added 2 commits May 14, 2020
Co-authored-by: David Fischer <david@readthedocs.org>
@ericholscher
Copy link
Member Author

ericholscher commented May 14, 2020

Going to ship this, since it's definitely something users have had questions about. We can iterate from this as a starting point.

@ericholscher ericholscher merged commit 9e10a03 into master May 14, 2020
2 checks passed
@ericholscher ericholscher deleted the choosing-a-site branch May 14, 2020
Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this is already merged, but I just saw it :)

* Less build time and fewer build resources (memory & CPU)
* Documentation is organized by projects

You can sign up for an account at https://readthedocs.org.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about adding "free account" here?

* More build time and more build resources (memory & CPU)
* Documentation is organized by organization, giving more control over permissions

You can sign up for an account at https://readthedocs.com.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe mentioning "you can sign up for a 30-days free trial"?

--------------------------

|com_brand| is meant for companies and users who have private documentation.
It works well for product documentation as well as internal docs for your developers.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of "developers", maybe "employees"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants