Git Product home page Git Product logo

Comments (2)

nottrobin avatar nottrobin commented on July 22, 2024

Thanks @matthewpaulthomas for your input.

It seems to me that your points can be summarised as follows:

  • There are many (an increasing number of?) sites with overlapping functions
  • Canonicalers (people in general?) have a tendency to erroneously build new services rather than improve existing ones
  • Having many separate websites & services makes it harder for people to find things they're looking for

As one of the architects of tutorials.ubuntu.com, I will try to lay out my understanding of the reasons behind its existence, especially with a view to these criticisms.

Avoidance

We are gradually rebuilding developer.ubuntu.com anyway (developer.ubuntu.com/core is the first part of this rebuild). Therefore, I can assure you that we are not simply duplicating functionality from developer.ubuntu.com simply to avoid improving the original site itself, as we are improving the original site itself, and therefore had equal opportunity to add tutorials to developer.ubuntu.com as to create a new service.

Finding content & multiple services

Helping users to find content is about logical structure, good menus, good links and search optimisation. This can be done well or badly, but it doesn't ultimately make much difference to this effort whether the content is structured in subpaths of the same domain or on different domains, as long as content is grouped logically.

Similarly, I don't believe there is inherently a problem with having multiple domains or services - they are simply another tool we have at our disposal for organising content and functionality. I do completely agree with you that duplicating functionality or content across multiple services leads to chaos. I hope that's not what we are doing, and that we are instead using separate domains to logically group functionality, as I will explain further below.

The relationship between developer.ubuntu.com, tutorials.ubuntu.com and docs.ubuntu.com

The existing developer.ubuntu.com had a pretty-much universally recognised problem that it was very difficult to find what one was looking for. This can hopefully therefore be an illustration that having a single service does not inherently make things easier to find. This is exactly why we chose to rebuilt it.

In the months we spent analysing the site and deciding how to simplify the structure, we basically decided that developer.ubuntu.com was suffering from trying to be two separate things:

  • An editorial site, introducing and explaining our various technical products
  • A technical resource, containing some documentation (alongside all the other bits of Canonical documentation dotted around everywhere)

The technical resources could further be split into two separate types:

  • Technical documentation, pertaining to specific versions of specific software products
  • Step-by-step tutorials - simple, easy-to-follow guides

The problem of trying to be too many things didn't just apply to the content - it also applied to the functionality. Too many functions were being performed by a single CMS application, and it was making it a very complex and difficult piece of software to work with.

Therefore, we made the decision to split up these types of content into three separate services:

  • developer.ubuntu.com for editorial descriptions of our technical offerings
  • docs.ubuntu.com for all technical documentation
  • tutorials.ubuntu.com for step-by-step guides

This was specifically to avoid mixing different types of content and different types of functionality. This will hopefully keep things simple, both from a content and functionality perspective, as well as freeing us up to use the most appropriate technology in each case.

In summary

The decision to create tutorials.ubuntu.com was not made in a vacuum. We carefully considered the existing sites and services, and specifically decided on this structure, in full knowledge of developer.ubuntu.com and our other suite of sites.

I hope my explanation above may have allayed some of your concerns. But in any case, this decision took a long time to arrive and it is not one we will be revisiting any time soon. I will, therefore, be closing this issue.

Thanks again for your input.

from tutorials.ubuntu.com.

matthewpaulthomas avatar matthewpaulthomas commented on July 22, 2024

I realize it must be incredibly frustrating to have worked on a site for weeks or months, only to receive a complaint that it shouldn’t exist! And it’s true there isn’t inherently a problem with having multiple domains or services. In theory, it’s possible to have coherent and consistent user journeys across separate sites. login.ubuntu.com is a (fortunately minimal) case where, for technical reasons, we have no choice.

In practice, however, I’m not aware of any non-minimal case on ubuntu.com over the past decade where this has ever been achieved. It didn’t happen with any of the cases I cited, you haven’t mentioned any cases where it has happened, and it certainly hasn’t happened with tutorials.ubuntu.com. Practical examples:

  • The Intel RealSense tutorial can’t be found by searching ubuntu.com, it can’t be found by searching developer.ubuntu.com (zero results!), and it can’t be found even by searching tutorials.ubuntu.com (since as a new separate site it doesn’t have its own search function, work that will need doing once there is more than one page of tutorials).
  • Though there are only six tutorials so far, one of them is (as I mentioned) identical in scope to a developer.ubuntu.com article. Similarly, another tutorial is identical in scope to a docs.ubuntu.com article. This is not a bad thing — some people learn better with one format, other people with another — but nowhere is this choice actually offered. People will only ever arrive at one or the other by accident.
  • If, having completed the Intel Joule tutorial, you want to try the same thing with a Raspberry Pi, you’re at a dead end, even though we have an article on doing that. If you were on developer.ubuntu.com you’d see it linked from the same place as the Joule materials, but because you’re on tutorials.ubuntu.com you don’t. There will always be dozens of topics that are covered only in one format, so arranging information by format rather than by topic will always produce needless dead ends.

As more tutorials are published, navigation problems like these will proliferate. And since you mention docs.ubuntu.com, that site suffers similarly: its separation leads to many links being marked as external, so inevitably one (“Read the MAAS documentation”) is marked as external by accident; none of the internal pages link to the relevant product site, flummoxing you if you arrive from a search engine; the custom navigation is so unusual that none of its pages even link back to the docs.ubuntu.com main page; and developer.ubuntu.com’s newly-rebuilt Core section consists entirely of things that could reasonably be described as “documentation”, but then has a “Documentation” page that does nothing except link to separate “documentation”, because that other documentation happens to be hosted on a different site, because it happens to be generated by a different CMS, which fact is of no relevance to users whatsoever.

All of these could be reported as separate issues. As you say, integrating with developer.ubuntu.com would not magically make everything easy to find. And I’m sure having different CMSes serving the non-navigation parts of different pages on a single site is non-trivial. But if they did, so the tutorials were integrated into the existing site, few if any of these issues would have occurred in the first place. Trying to address them on separate sites will be pushing water uphill.

from tutorials.ubuntu.com.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.