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 deployment on Digital Ocean tutorial #857

Closed
wants to merge 7 commits into from
Closed

Conversation

malloxpb
Copy link

Improves: Add the deployment on Digital Ocean tutorial right after deployment on Ubuntu VPS to illustrate a deployment method for users. I have fixed the indentation by following the ReST style guide in the Documentation. If there is any other mistakes, please let me know so I can continue working on fixing them.
In addition, I think this is necessary since I think a lot of people who just start to use Plone might struggle with deployment (testing env is important for both developers and clients). A suggestion might be a good solution to that.
If there is any other better location for this tutorial, I won't hesitate to start working on migrating this PR :).

Cannot install lxml==3.5.0
--------------------------

**Traceback**::
Copy link
Member

Choose a reason for hiding this comment

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

you can use .. code-block:: console here.

hvelarde
hvelarde previously approved these changes Nov 16, 2017
Copy link
Member

@hvelarde hvelarde left a comment

Choose a reason for hiding this comment

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

LGTM

@svx
Copy link
Member

svx commented Nov 16, 2017

I am still not sure abut this at all :)

This may seems now as a great idea, but could be really bad in the long term.

Let me explain:

  • The first part if this PR is already great and long explained by DO itself in their own docs.
    This is IMHO not part of Plone.
  • The rest ofthe docs in this PR is already covered in our own installation docs.

If we decide to merge that, it will IMHO increase our own workload, since we need to keep that document up to date, too.

For example say DO is changing their UI or something else.

There is as far as I can see nothing in these PR what we do not have already in our docs.
If we start with adding it for DO, what is coming next, a custom manual for providerX ?.

IMHO it would be better to have a good look what we (may) need to improve in our already documentation, than add almost the same docs we already have.

Keeping all these small pieces in sync is really time consuming !

Better less but working and up to date docs, than more and possible fast outdated.

Please also consider how people use docs. Having this for DO but not for others can be lead to confusions.
A IMHO way better solution is to add to our already existing docs a line that all this works on DO, Linode, Rackspace, etc.
If really needed we could use here our os-example add-on (Sphinx) to highlight and explain the possible differences.

@polyester what is your take on that ?

@svx
Copy link
Member

svx commented Nov 16, 2017

BTW: This PR is not following our style-guide at all ! :)

@hvelarde
Copy link
Member

so maybe this can be included on DO documentation instead :)

@svx
Copy link
Member

svx commented Nov 16, 2017

@hvelarde If that would end up in the official DO docs, yes that would be great !!!

@hvelarde hvelarde dismissed their stale review November 16, 2017 13:52

I changed my mind after reading @svx comments.

@polyester
Copy link
Sponsor Member

If it can be 'outsourced' to Digital Ocean docs, that would be good.

Otherwise, I agree with @svx, this will get outdated fast, and is very specific to one particular provider.

On the other hand, it is a tutorial, which in and of itself has value, and has a different goal. The main benefit being, that people can go through it in one go.

If we take it in, I would not put it under /manage/deploying/production, but rather under a (new?) heading "tutorials". Then we could put a clear intro paragraph saying this is valid as of November 2017, and is presented 'as is'.

Haven't completely thought this through, but in short:

  • I think it should not go into the main 'deploying' docs
  • but it may have value as a 'beginner tutorial', and then should be put under an appropriate section.

all open for discussion of course

@svx
Copy link
Member

svx commented Nov 16, 2017

Excuse my impoliteness, just something to take in mind :)

IMHO this should be not forgotten if people bring up the idea about tutorials again :)

We once included tutorials and that was/is in the docs of Plone 4, for example: https://docs.plone.org/4/en/external/tutorial.todoapp/docs/

This is still beating us and creating headaches ! :)

  • No one ever took care of making sure it is still working and following best practices
  • No upgrade to Plone 5
  • Tutorials are written in a different tone of voice, usually even with a different style-guide :)

People still sending mails (via freshdesk) that the tutorial is not working :).

Because of this and a couple of other reasons, we decided for the docs of Plone 5 to not include tutorials or even new code examples.

Instead we link to the awesome training documentation, which is updated at least once a year :)

Please, my intention is not to offend anyone, I just wanted to remind that we been there before and it may be worth to evaluate carefully.

Thanks ! :)

@polyester
Copy link
Sponsor Member

Ok I'm convinced

@stevepiercy
Copy link
Contributor

The Pyramid Community Cookbook is another example of what @svx describes. We got great documentation or a tutorial that is valid for a while, then the provider changes their implementation and no one maintains it. The Cookbook is slowly becoming a collection of links to blog posts and other documentation.

We have only supported tutorials and documentation in our official documentation, which we found to be a good line in the sand.

Copy link
Sponsor Member

@tkimnguyen tkimnguyen left a comment

Choose a reason for hiding this comment

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

I've read over the comment thread and I have to defer to Sven and Paul on whether this fits with the current docs structure. I do see great value in having this sort of how-to, especially as it helps with Plone adoption. The question is: how could we commit to maintaining this type of installation how-to so it remains up to date for changes to DO and to Plone? For which other deployment platforms should we have such an installation how-to? Linode, Amazon, etc.

@tkimnguyen
Copy link
Sponsor Member

Can we recommend or create another place for @nctl144 's contribution to live?

@svx
Copy link
Member

svx commented Nov 19, 2017

Ok sorry for repeating myself lets look at it again:

  • First it explains how you create a VM on DO.

This is not part of Plone !
Every provider, be it DO, Linode, Amazon etc, have into the deep and up to date docs how you create VM on their platform.
They keep them also up to date, because this is their business.

Starting with this kind of docs on docs.plone.org is like opening pandora's box

  • It adds lots of extra work for to little people
  • Who decides which provider we write docs about ?

Looking further at it from a 'marketing' or 'communication' point of view:

I do not see the value, I see unclearness and user confusion, with that we 'just' would add another place with some parts of installation docs, which makes it really hard for user looking for information.
It messes up SEO, may gives you different info than other install docs.

The second part of this pr is like already written above repeating our already existing docs about installation.

Like I also already wrote above, if there is any info in this pr which we are emissing about the install it would be IMHO better to just include this little parts into our existing docs.
ANd if we really thing it is helpful we also can link to the docs of various could providers about 'VM creation'.
This would be way better and smarter than writing the stuff on your own.

@tkimnguyen
Copy link
Sponsor Member

Maybe if Sven doesn't want this in the official docs, you can add it to the Digital Ocean how-to articles if they have Linode's equivalents at https://www.linode.com/docs

@hvelarde
Copy link
Member

hvelarde commented Dec 4, 2017

I think is clear now that this must not be in the documentation; fill free to reopen if I'm wrong.

@hvelarde hvelarde closed this Dec 4, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants