Weblog
Laurence Rowe: Layering web applications on web services with JSON Linked Data
Talk by Laurence Rowe at the Plone Conference 2014 in Bristol.
This talk is about the ENCODE portal, an encyclopedia of DNA elements.
I want to talk here about a pattern, not really about the specific technologies involved.
I work at the data coordination center, generating and organizing data. We get metadata submissions, store it in a metadata database. It is really a knowledge management system. It could have been built in Plone, but it would not be a great fit. I started from scratch based on Pyramid and ReactJS. Nowadays services more and more have a Javascript UI, where Javascript talks to the backend.
Embrace Javascript. There has been progressive enhancement. Single page web apps really need it. For building a portal, I have been looking at isomorphic web applications. Originally from the Render framework. It is important that pages are loading quickly. The exit rate for visitors goes just as quickly up with the loading time.
Json is the lowest common denominator for data. xml is more flexible, but more complex. In Python it is much easier to use json.
JSON-LD: json link data. Adopted recently by the w3c. It is partly about semantic data, but we are not using that yet.
At first we needed to duplicate the routing information on the server and the client side. JSON-LD allows us to express type information, which avoids the duplication.
You can have JSON-LD like this [in "pseudo json" here, just for the idea, Maurits]:
{ @context: context/jsonld @id: ... @type: [biosample, item] @submitted_by: { @id: /users/lrowe @type: [user, item] name: Laurence Rowe } }
Defined using JSON Schema, which is an IETF draft. Schema version, field definitions, types, validators. It is an extensible format.
All our normalized data is stored in Postgres as json. JSON-LD has the concept of framing, which objects should be embedded (mapping to a view in Plone terms), possibly doing some elasticsearch. Above it is server rendering (with NodeJs) that is creating html, and sends it to the browser. After the first page load, the browser uses Javascript to talk the the JSON-LD backend directly, instead of via the NodeJS server, letting the ReactJS Javascript do its own rendering.
The browser opens a page. Gets html back. Then it does a query for json data and gets that back and shows it on the page.
Indexing linked data. Updating one item may need a reindex of other items that link to it. We have written code for that. Using elasticsearch as a cache.
Come work with us, we are hiring.
See code at https://github.com/ENCODE-DCC
Guido Stevens: The Plone Intranet Consortium
Talk by Guido Stevens at the Plone Conference 2014 in Bristol.
This is a big picture presentation. But don't worry, there will be a demo at the end.
United we stand, divided we fall. Plone is in a rough spot. Let's design and build some solutions. Yes, Wordpress is eating our lunch and our cake, but we should not sit back.
Code: https://github.com/ploneintranet/ploneintranet.suite
I have my own company, Cosent.
The Plone community is good. The backend code is good. The user interface was good, but has fallen back. Good enough is not good enough anymore. We need to do better. Only excellent user experience will win us customers.
When as a Plone company you want to sell Plone as an Intranet, you have a good starting point, but you are missing lots of pieces. You would have to build that yourself and let one customer pay for it. That is not going to happen, or at least it is a hard sale.
In the Plone community, the number of commits per month is rising, and the number of committers per month is also rising. Doing pretty well.
So what is wrong? We need to evolve or we will die, like dinosaurs. Plone Core currently is Web 1.0. We need a Plone Social, web 2.0: read/write, social networking, activity stream, time centric, personal perspectives, bottom-up sharing.
Roadmap: http://cosent.nl/roadmap
In 2010 I had the choice to ditch Plone or fix Plone. I chose to put all my eggs in one basket: Plone. Is Plone Social good enough? No. Look at Jive, that is some serious competition. We do not need to beat such a SAAS product, but we need to be close. Then customers will still prefer the local company that is closer to them and more attuned to their needs.
I think the "spare time" model of development is broken. It has brought us this far, but it is not enough anymore. Stuff is nearly finished on sprints, and then lags too long.
We need a new model. We have the talent, the technology. We can do it. We need to invest in a high quality, out-of-the-box product baseline. Low purchase cost, immediate sales appeal, fast delivery, shared maintenance across the community, new community ethos in collaborating together.
As Plone Intranet Consortium we band together and want to work on this. We had a meeting after the Plone conference last year. Every company there had their own workspace solution, everyone was maintaining their own stack. But they did not have enough resources to generalize it for the community.
Design first. Design is not about eye candy. You start with a decent vision of what your strategy is, what your project is trying to solve.
Roadmap-driven Scrum development. Normal working day, in company time. Legitimate leadership serves the community. The consortium board funds the roadmap. Investment per company: 1000 euro per month, plus one developer day per week. Cash is used to hire people to help with the design. Sprint every Wednesday.
It is 100 percent open source. It is not a product that we will make money on. We will make money on the service we deliver. We want to move the license to the Plone Foundation, we will talk about that.
What we are developing, are add-ons, not a core fork. Plone 5 compatible. Will port to mockup. You are welcome to join the consortium.
Cornelis has made a patternslib-based clickable prototype, that needs no backend to operate.
Demo by Alexander Pilz.
User experience sells. We showed this demo to a client last week and he thought it was an impressive preview of social functions in future Plone.
Roadmap. Phase one: activity streams, team spaces, dashboards, document structures/wiki. Phase two: calendaring, search, news hub.
We are pioneering a new business model for open source.
- Dream a vision.
- Combine investment.
- Design first! Use dedicated designers.
- Develop and release.
- (or really 3.1 already) Win customers.
We can boldly go where no one has gone before. We are Plone, we can do anything.
We have an open space tomorrow. Welcome! Sprint on Saturday and Sunday.
Jens W. Klein: Big Fat Fast Plone - Scale Up, Speed Up.
Talk by Jens W. Klein at the Plone Conference 2014 in Bristol.
I am owner of Klein & Partner, member of Blue Alliance, Austria. Doing Plone since version 1.0.
Default Plone is not so fast. Scales great horizontally (so adding machines), but there are still bottlenecks, primarily loading stuff from zodb.
First customer Noeku, over 30 Plone sites, hi availability, low to mid budget, self hosted on hardware, VMs. The pipeline is: nginx, varnish, pound, several Plone instances, databases (zodb, mysql, samba).
Second customer Zumtobel, brand specific international product portals, customer extranets, b2b e-shop, hosting on dedicated machines.
Third customer HTU Graz, one Plone site with several subsites (with lineage), lots of students looking at it, so we have a peak load.
Main Plone database is ZEO or PostgreSQL, plus blobstorage (NFS, NAS). Load balancer: haproxy or pound. Caching proxy: varnish (don't use squid please). Webserver: nginx (better not use apache).
The Plone instances and the client connection pool (between Plones and database) can use memcached (maybe multiple), LDAP, other third party services.
If you want to improve things, you must measure it: use munin, everywhere you can. fio is a simple but powerful tool to get measures on your io. Read up on how Linux manager disk/ram. Know your hardware and your VMs (if any).
Database level
- Noeku: zeo server, blobstorage, both replicated with drdb
- Zumtobel: RelStorage on PostgreSQL, blobs from NAS over NFS.
- HTU Graz: RelStorage on PostgreSQL, all on one machine.
First things first: never store blobs in ZODB: use blobstorage. Standard Plone 4.3 images from news items are stored in zodb. You can change that. Check your code and add-ons.
ZEO server plus blobstorage: ensure a fast IO to harddisk or RAM, and have enough RAM for disk buffering.
Blobstorage on NFS/NAS: shared blobs and mount them on each node. Mount read-only on web server node and use collective.xsendfile (X-HTTP-Accel) to make it faster.
RelStorage plus blobstorage: never store blobs in the SQL database (same as zodb). No MySQL if you can avoid it. Configure your SQL database.
Connections pool: ZEO vs RelStorage. ZEO server pushes invalidations to client. RelStorage: ZEO client polls for invalidated objects. Disk cache of pickled objects per zope instance. On RelStorage size you can use memcached, which is a big advantage, reducing load on the database.
- Noeku, ZEO.
- Zumtobel: RelStorage, history free, 2 VMs, 16 instances plus some worker instances for asynchronous work, each 2 or 4 threads. RAM cache 30,000 or 100,000 objects, memcached as shared connection cache. If packing takes too long, try relstorage_packer.
- HTU: RelStorage, history free. 6 instances, each 1 thread. RAM cache 30,000 objects. This is something you need to tweak, try out some values and measure the effect. Memcached. Poll interval 120 seconds. Blobstorage: shared folder on same machine.
The above is not specific for Plone. The below is.
Plone
- Turn off debug mode, logging, deprecation warnings.
- Configure plone.app.caching, even if you are not using varnish. Browsers cache things too and it can really help.
- Multiple instances: use memcached instead of standard ram cache.
- Know plone.memoize and use it.
- Never calculate search twice. Check your Python and template code to avoid things that boil down to: if expensive_operation(): expensive_operation().
- Use the catalog.
- Do not overuse metadata: of you add too many metadata to the catalog brains, they may become bigger than the actual objects, slowing your site down.
Write conflicts:
- 90% of write conflicts happens in the catalog.
- To avoid it, try to reduce the time of the transaction. Hard in standard situations, but you may be able to first prepare some data and later commit it to the database.
- Use collective.solr or collective.indexing. I hope that in Plone 6 we will no longer have our own catalog, but use SOLR.
Lots of objects, hundreds of thousands? Are catalog queries slow? Use a separate mount point for the portal_catalog, with higher cache sizes.
Archetypes versus Dexterity. In AT, you should avoid to wake up the object, ask the catalog instead. With Dexterity, it is sometimes cheaper to wake up the object: if objects are small and you iterate over a folder or subtree, or if adding lots of metadata to the catalog would be needed.
Third party services, like LDAP and other databases, need to be cached. Talking to external systems over the network is slow.
In case of serious trouble: measure! munin, fio, collective.traceview, Products.ZopeProfiler, haufe.requestmonitoring, Products.LongRequestLogger. Change one thing at a time and measure it. Really important!
plone.app.caching: always install it. For custom add-ons with own types and templates, you need extra configuration for each type and template. Do this! Calculate in some time for this task, it is some work, but it is well documented.
On high traffic, introduce a new caching rule for one/two/five minute caches, really helps against peak load.
Load balancer. Pound is stable but old and difficult to get measurements. Haproxy not that simple, newer, nice WebUI for stats. You should point the same request type to the same instance.
Web server: nginx. Set the proxy_* to recommended values.
Read more: on docs.plone.org.
Looking up attributes in Dexterity can be slow, we need to fix that.
Watch the video of this talk.
Plone Lightning talks Wednesday
Lightning talks at the Plone Conference 2014 in Bristol.
Steve McMahon: Plone installation, the future
What is the Installer team doing for Plone 5. You can still use your custom buildout, no problem, so your future may still vary.
Unified Installer will still work. Platform binary installers may not work; possibly Windows; nearly certainly not OS X, as it gets harder and harder to do open source development there.
The hot newness is Cloud or VM kits. We are working on making that happen for Plone too. Our principal tool is going to be Ansible. Build a full-stack server. Vagrant instance to test it before you deploy it. We are not scaring people away from other approaches.
Targets: from 5 to 5000 dollars per month, with configuration. Working on boxes for Digital Ocean, AWS, etc.
Plone 5: no longer ZopeSkel or templar, but mr.bob as tool for bootstrapping a new project. You are free to use the tool you like.
Paul Tax: Anniversary sprint
I am the new guy at Four Digits, Arnhem, The Netherlands. We are organizing a sprint on 22 till 26 June 2015. Hotels near, good wifi, standing desks if you want, agile planning, standups, food and drinks. Party on Friday, because it is our ten year anniversary. No problem if you only want to join for the party. Homebrewn beer.
Paul Roeland: Paragon
Paragon is the search for the very best in Plone add-ons. The hunt is on, especially for add-ons making the lives of integrators easier. No undead add-ons please, no unmaintained. Just good, useful add-ons. You can nominate until November 14. Are they maintained? Are they safe to put on a production site? Go to http://paragon.plone.org and nominate an add-on. Sorry, there are a lot of fields to fill in, but only a few are required. But the more the better, thank you for helping us. Results will be announced in December. We will feature those on the new plone.org.
Asko Soukka: venusianconfiguration
Venusian configuration: no more zcml. Put that configuration in a Python file. It can scan modules, a bit like grok, but explicitly. It will not be released, because I don't want all the hate mail. :-) But maybe incorporate it in Zope configuration.
Sally, Cris, Jens, Alexander, Andreas: bibliographies
Bibliographies are really important to a certain segment of users, academics specifically. There is funding to make some things better. This is a call for help. I scheduled an open space for this topic on Friday, please come and give your input. Create a plan of action.
Manabu Terada: Recent topics about Plone in Japan
PyCon Japan September 2014, 500 people, one English track. I conducted a session about Plone, about 100 people attended. Number of Python developers is increasing in Japan. We wish to spread Plone usage in Japan. Next year: Plone Symposium Tokyo! May/July 2015. Get interesting sessions, so speakers from overseas are very much invited. Airport, big city: English is no problem, outside may be difficult. Tokyo is very cheap. Safe? Yes, we even hold the Olympics in 2020. See you in Tokyo next year.
Maurizio Delmonte: Plone 5 at Sorrento
Abstract also exists for ten years. Join us at the Sorrento sprint next year. Don't wait until the end to save your room. It is somewhere in April 2015.
Here is a video of last year with people talking about Plone 5.
Bogdan Girman: dexterity base classes
Working at Der Freitag, Berlin. We have a dexterity content type Article. We needed to change the base class? One trick would be to delete the object and add it to the parent again, but that does not work with the event handlers that we also have. Main code to work around that:
parent._delOb(...) parent._setOb(...) obj.reindexObject(idxs=['is_folderish', 'object_provides'])
Eric Brehault: Why CMS won't die
All CMS are old. Wordpress is young at 2003.
We can make a no-CMS site quite easily. But a validation workflow and access rights would be nice. Newsletter. Document sharing, with some people. Multilingual. Next thing you know, your no-CMS crashes.
Face it, you need a CMS!
CMS are special. We are CMSistas, and only CMSistas know it. CMS are huge projects. For example: who needs buildout in Python, except us?
Wordpress is about 60 percent of all CMS websites. Huge! But 100 percent tomorrow? No way. I never saw Wordpress at any of my customers.
Nobody promises it will be easy. Is Plone too complex? Every CMS is complex.
Watch the videos of these lightning talks, part 1 and part 2.
Paul Roeland and Sven Strack: Cultural Learnings of Documentation for Make Benefit Glorious Nation of Plonistan
Talk by Paul Roeland and Sven Strack at the Plone Conference 2014 in Bristol.
If you still think documentation is about "how stuff works", you are doing it wrong. There is a lot of software around, people have lots of choices, people being future clients, developers, users, community members.
Also, your future self will thank you. It is good to know what that idiot was thinking half a year ago.
Sometimes you just want to use a four letter word: RTFM. Read the fine manual. But then there has to be a manual. If people don't know Plone, they won't use it.
A year ago, in Brasilia, a plan was born. We were really unhappy with the state of documentation last year. Spread around over the internet.
A robot master, documenter, marketeer and 9 others walk into a bar and... Well, it was an office, well there was a bar involved, but anyway. Sisi Nutt did a lot there. Without her the documentation would not be so far as it is now. It has been tested on live humans (testing on animals is not allowed).
We had a reality check on the Write The Docs conference in Berlin. Good to get input and feedback from other people. We are now testing broken links using continuous integration, which was new to them.
So now we want more, better, nicer, shinier, sweeter. What we are now telling about documenting Plone, you should apply that to your add-ons too. If it is not documented, it is not used.
- Define what the audience is of your documentation, or for a specific part of your documentation. Structure your docs accordingly.
- Soft landings are important. So add introductions. Let people see if this chapter is what they are looking for.
- Get the tone right. Friendly and professional go a long way. Don't scare off users, unless you really want to. Ask for help, especially if English is not your first language.
- Consistency. Don't leave your readers hanging, nor your contributors. Always use the same terminology. Write and follow style guides. Do not make it too complicated. Read the Zen of Python (import this) and apply it to your documentation as well.
- Versioning. Different software versions need different docs. Benefit: you can retire the old. This is what we will do soon. On http://docs.plone.org you will see the Plone 4 docs by default, and can choose a different version.
- Spellcheck is a wonderful invention, please use it.
- We love humor. Please do not do that in documentation. Highly culturally charged. It gets old quickly and docs are meant to last.
- Sarcasm is never a good idea in docs. Nor in irc, for that matter.
- Testing is essential. Test it on somebody who is not an expert in the field. Does your audience get it?
Now for some tools. Search docs right from Sublime. It has integrated search for Chrome, Firefox, DuckDuckGo. Or using Dash (OS X) and Zeal (Windows, Linux).
Quality control. We have robot screenshots. Automated spell check. We add some words to the known words list, which doubles as a Kudo list, for example we have added David Glick to that list, otherwise we get errors from the spell check.
Challenge
As a project we need documentation. It is not hard, it is just something you need to start doing. We need to get to work.
- We need people with deep skills. For example, a lot of documentation is using grok, which is not recommended anymore, so can someone please update that.
- We need people new to Plone. Get an intern to read and try out the documentation, to see if it is still correct.
- We need help translating at least end user documentation.
- Use semantic line breaks, not just after 79 characters, because half sentences are really hard to translate.
- We need Python developers too for creating some code for helping to create the docs.
- Please put some energy in it, also time from your company, pretty please. The 10 percent Plone manifesto is still good.
Is there a Plone style guide? There is a beginning, needs extension. It is in the How to contribute section.