Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [mylyn-docs-dev] Website for Mylyn docs

Great to see interest in improving the Mylyn Docs site.  The issue here is that most components within Mylyn Docs grew up with their own identity before Mylyn Docs was formed - so very little effort has gone into it.

Priority for us should be to fix the description.html since that's the first thing people will see.  We should avoid duplicating content on the wiki if possible - perhaps we just point it to the mylyn/docs page?

As for the links, I'm not sure how to fix those.  Anyone?

David

On Tue, Sep 18, 2012 at 7:43 AM, Jeremie Bresson <dev@xxxxxxxx> wrote:
Hi,

> we discussed this on the Mylyn call and the consensus was that we don't have
> the bandwidth to maintain a separate website and git repository for each
> sub-project. Hence I have gone ahead and resolved this bug which provides
> much nicer and more informative pages with links to all bug-projects for free
> (see http://www.eclipse.org/mylyn/docs/):

To my mind a good landing page (like
http://www.eclipse.org/mylyn/docs/) should
provide a quick and good overview on the project.

>From this point of view, the data-driven websites provide too many
information.
Who care about "commit activity" or the list of all releases on the
first page.

On the other side, maintaining a regular project website requires a lot
of
time. There is a need for good content and for good page organization.
The
mechanism described by Alex Lagarde at #Comment 5 is also a legit
requirement
for project containers like mylyn docs. This should also be implemented
if we
go with a regular project website.

See: https://bugs.eclipse.org/bugs/show_bug.cgi?id=389480#c5

Let say that considering the effort required by a specific website,
using the
data-driven pages for the moment is the best solution.

We should move forward and improve what we have for the moment:

1. Improve the wiki Page:
http://wiki.eclipse.org/Mylyn/Docs

2. Work on a good description.html
(I suggest to wait for Bug 389672. Then we can make a proposal using
gerrit)

3. Improve the navigation tree on the left (in the data-driven page)

For the moment 3 links point to the same page at the end, and there is
link
to "Mylyn" that has nothing to do with "Mylyn Docs"

Mylyn Docs [1]
|-> Website [2]
|-> Wiki [3]
|-> Getting Started [4]
|-> Documentation [5]
|-> Plan [6]
|-> Downloads [7]


* [1] Mylyn Docs
Link to
http://www.eclipse.org/projects/project_summary.php?projectid=mylyn.docs
This is a redirection to:
http://www.eclipse.org/projects/project.php?id=mylyn.docs
Probably OK.

* [2] Website
Link to http://www.eclipse.org/mylyn/docs/ OK

* [3] Wiki
link to http://wiki.eclipse.org/Mylyn
should be http://wiki.eclipse.org/Mylyn/Docs

* [4] Getting Started
link to http://eclipse.org/mylyn/start/
Not OK, this is Mylyn content and has nothing to do with Mylyn Docs.

* [5] Documentation
=> http://wiki.eclipse.org/Mylyn/User_Guide
Not OK, this is Mylyn content and has nothing to do with Mylyn Docs.

* [6] Plan
link to
http://www.eclipse.org/projects/project-plan.php?projectid=mylyn.docs
Is OK, but Mylyn Doc does not seems to have a plan.

* [7] Downloads
link to http://eclipse.org/mylyn/downloads/
This is OK because WikiText downloads are available from this page.

Where are the links for the navigation? What is the process to make a
change proposal for these links?


Jérémie



On Sat, 15 Sep 2012 21:50:27 -0700, Steffen Pingel
<steffen.pingel@xxxxxxxxxxx> wrote:
> Hi,
>
> we discussed this on the Mylyn call and the consensus was that we
> don't have the bandwidth to maintain a separate website and git
> repository for each sub-project. Hence I have gone ahead and resolved
> this bug which provides much nicer and more informative pages with
> links to all bug-projects for free
> (see http://www.eclipse.org/mylyn/docs/ [1]):
>
>  354513: use data driven websites for sub-projects
>  https://bugs.eclipse.org/bugs/show_bug.cgi?id=354513 [2]
>
> The description part is HTML that we can easily change, add
> screenshots, links to the Wiki etc. like we did for the MFT project
> for
> example: http://www.eclipse.org/projects/project.php?id=mylyn.context.mft
> [3] . Jeremie, please let us know if you have suggestions for
> updating the content.
>
> That said, if anyone wants to step up to maintain the Mylyn Docs
> website we can of course replace the data-driven page with a regular
> project site at any time. I would suggest to open a Bugzilla bug for
> that with a proposal and content etc. so that we can review and
> consider the request.
>
> I'll have opened a bug to migrate the existing content that is served
> under http://eclipse.org/mylyn [4] which includes the description.html
> for Mylyn Docs to Git to make it more easily accessible:
>
>  389672: Move Mylyn website to Git
>  https://bugs.eclipse.org/bugs/show_bug.cgi?id=389672 [5]
>
>  Steffen
>
> On Thu, Sep 13, 2012 at 1:23 AM, Torkild Ulvøy Resheim  wrote:
>  Great initiative Jeremie!
>
>  I agree that we absolutely need to do something about the web page.
> If we could get access to it committers and even contributors would be
> able to improve on it. Note that we also have
> http://www.eclipse.org/projects/project.php?id=mylyn.docs [7] for the
> technical bits.
>
>  Best regards,
>  Torkild
>
>  13. sep. 2012 kl. 10:14 skrev :
>
>  > Hi,
>  >
>  > The website of Mylyn Docs [1] is really empty.
>  > Could Mylyn Docs open a request to get its git repository for the
>  > website [2] ?
>  >
>  > After the repository creation, we could start to create content.
>  > To my mind the website should be as small as possible.
>  >
>  > * Description of the (sub)project / components:
>  > - EPUB tooling
>  > - Docs Framework
>  > - HtmlText
>  > - Wikitext
>  > - Vex ?
>  >
>  > * Link to the other content sources:
>  > Wiki, Eclipse Help, Mylyn download section, forum...
>  >
>  > It is important for every Eclipse Project to have a good landing
> page.
>  > New users will check this first to get information.
>  >
>  > I could propose a first version that commiters can
>  > review/correct/improve, before putting it online.
>  >
>  > Jeremie.
>  >
>  >
>  > [1] http://eclipse.org/mylyn/docs/ [9]
>  > [2]
>  >
> http://waynebeaton.wordpress.com/2012/08/28/migrating-eclipse-project-websites-to-git/
> [10]
>  >
>  >
>  > On Wed,  5 Sep 2012 00:00:12 -0400 (EDT), emo@xxxxxxxxxxx [11]
> (portal on
>  > behalf of emo) wrote:
>  >> David,
>  >> Projects are required to keep meta data up to date using the
> MyFoundation
>  >> Portal (http://portal.eclipse.org/ [12]).  The following
> problems were found
>  >> with this project's meta-data:
>  >>
>  >> * Project home page does not exist (projecturl =
>  >> http://eclipse.org/mylyn/docs/ [13] returns a 404)
>  >>
>  >> _______________________________________________
>  >> mylyn-docs-dev mailing list
>  >> mylyn-docs-dev@xxxxxxxxxxx [14]
>  >> http://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev [15]
>  >
>  > _______________________________________________
>  > mylyn-docs-dev mailing list
>  > mylyn-docs-dev@xxxxxxxxxxx [16]
>  > http://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev [17]
>
>  --
>  Torkild Ulvøy Resheim
>  Consultant / Eclipse Committer / Senior Software Developer
>  Itema AS - http://itema.no [18]
>
> _______________________________________________
>  mylyn-docs-dev mailing list
>  mylyn-docs-dev@xxxxxxxxxxx [19]
>  http://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev [20]

_______________________________________________
mylyn-docs-dev mailing list
mylyn-docs-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev



--
David Green
VP of Engineering, Tasktop
Committer, Eclipse Mylyn
http://tasktop.com 
+1-778-588-6896 ext. 115



Back to the top