Bug 213001 - Extensive gardening required for the wiki
Summary: Extensive gardening required for the wiki
Status: ASSIGNED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: STP (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P1 major (vote)
Target Milestone: ---   Edit
Assignee: Oisin Hurley CLA
QA Contact: Oisin Hurley CLA
URL:
Whiteboard:
Keywords: usability
Depends on:
Blocks:
 
Reported: 2007-12-14 05:39 EST by Oisin Hurley CLA
Modified: 2012-09-21 14:41 EDT (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Oisin Hurley CLA 2007-12-14 05:39:29 EST
The wiki is a bit messy and has a considerable amount of dead information on it. Here's a quick outline of what the structure could be like to make things a bit neater - we ca  use the capability of the wiki to have hierarchical names to make things easier to navigate.

Front Page  -> contains about, download instructions, latest news and links

Components 
    IM
    SOAS
    SC...    etc  there is a page for each component.

Planning  -> general planning material for the project, agendas, minutes
Developers  ->  getting a build done, checking things out, explanation of code layout etc
Documents -> presentations, articles, tutorials, flash demos, etc
Events ->  conferences, initiatives, meetups, regular conference calls

Cleaning up the site will cause peoples links that they have saved to break, so apologies in advance!

The actual wiki names will look like:
STP
STP/Component
STP/Planning
STP/Developers
STP/Documents
STP/Events
Comment 1 Oisin Hurley CLA 2008-02-20 12:58:14 EST
I've started work on this, using some of the features borrowed from the Buckminster wiki and other elements to allow breadcrumb navigation.

I've put together starting pages for all the components and they follow the schema

STP/IM_Component
STP/BPMN_Component

etc, you can see the links at the components list at the bottom of http://wiki.eclipse.org/STP/TestPage

The plan is to slowly bring over all of the links from the existing front page of the wiki, and then encourage component leads to garden their own particular areas :)
Comment 2 Oisin Hurley CLA 2008-02-20 19:26:12 EST
Some stp-dev activity, for the record:

http://dev.eclipse.org/mhonarc/lists/stp-dev/msg01708.html
Comment 3 Antoine Toulmé CLA 2008-02-21 04:16:20 EST
As part of the work for EclipseCon 2008, I have started working on our component page.

I have added a particular category: BPMN that I will propagate to our pages.
Comment 4 Antoine Toulmé CLA 2008-02-21 04:39:27 EST
Oisin, I guess you will need to update this page:

http://wiki.eclipse.org/index.php/STP_Sub-project_specific_pages

Do we need to add the STP category everywhere in our component pages?

It seems using "subfolders" like STP/BPMN actually generates the STP/BPMN page.

Would it be possible to move the component home pages to that address ? It would certainly help people to find their way around.
Comment 5 Oisin Hurley CLA 2008-02-21 05:13:57 EST
(In reply to comment #4)
> Oisin, I guess you will need to update this page:
> 
> http://wiki.eclipse.org/index.php/STP_Sub-project_specific_pages

Yes, I'm going to take that page away completely, it is replaced by 
the Components section on the home page. I'll move all the content
to the component specific pages.

>  Do we need to add the STP category everywhere in our component pages?

This would be good. Categories are used for searching, and  there is
also a category 'index page' (eg http://wiki.eclipse.org/index.php?title=Category:SOA&action=edit)
which can serve as a overview of all the pages. 

I was just thinking it would be great to be able to visualize all of the
pages, and adding the STP category would be a good way to do that :)
 
> It seems using "subfolders" like STP/BPMN actually generates the STP/BPMN page.
> 
> Would it be possible to move the component home pages to that address ? It
> would certainly help people to find their way around.

That's right, and I do use this mechanism. You will see that the home page
for the BPMN component is

 STP/BPMN_Component

when you move links to your page, you should also do a 'wiki' move, changing
their name to

 STP/BPMN_Component/<PageName>

then when you navigate to <PageName> there will be a little breadcrumb
trail up at the top left of the page which helps people know where they
can go 'back up'.



Comment 6 Antoine Toulmé CLA 2008-02-21 05:22:29 EST
ok, so all pages must relate to the SOA category, and we should use:

STP/BPMN_Component/<PageName>

I had started working with STP/BPMN/<PageName>.

I'll get around this quickly.

Thanks!
Comment 7 Antoine Toulmé CLA 2008-02-21 05:54:17 EST
I found out that referencing the SOA category on your category page would mark it as a subcategory.

I think we can keep with tagging our component pages with our subcategory tag, as long as it is related to SOA as a subcategory.

Allright ?
Comment 8 Oisin Hurley CLA 2008-02-21 06:07:46 EST
(In reply to comment #7)
> I found out that referencing the SOA category on your category page would mark
> it as a subcategory.

That's strange - I don't think that was what was meant to happen. For example,
the Modeling category on the end of the page doesn't mean that BPMN has 
become a subcategory of Modeling (I checked it).

May a SOA/BPMN category has been introduced somewhere by accident?

> I think we can keep with tagging our component pages with our subcategory tag,
> as long as it is related to SOA as a subcategory.
> 
> Allright ?

It's ok not to have SOA as a category on your page, but I would like it if you had 
STP as  a category so that I can  then see all of the STP-related pages just by looking
at the category index.

Does that make sense?
Comment 9 Antoine Toulmé CLA 2008-02-21 06:22:40 EST
(In reply to comment #8)
> (In reply to comment #7)
> > I found out that referencing the SOA category on your category page would mark
> > it as a subcategory.
> 
> That's strange - I don't think that was what was meant to happen. For example,
> the Modeling category on the end of the page doesn't mean that BPMN has 
> become a subcategory of Modeling (I checked it).
No, it doesn't work like that. The category page is:

http://wiki.eclipse.org/Category:BPMN

If you go there, you will see that I added [[Category:SOA]] on it.

The SOA category (http://wiki.eclipse.org/Category:SOA) will reference it then.
> 
> May a SOA/BPMN category has been introduced somewhere by accident?
> 
> > I think we can keep with tagging our component pages with our subcategory tag,
> > as long as it is related to SOA as a subcategory.
> > 
> > Allright ?
> 
> It's ok not to have SOA as a category on your page, but I would like it if you
> had 
> STP as  a category so that I can  then see all of the STP-related pages just by
> looking
> at the category index.
> 
> Does that make sense?
> 
Yes, it'd be pretty. Ok, so I need to make BPMN a subcategory of STP, and have all the wiki pages categorized as STP. :P
Comment 10 Oisin Hurley CLA 2008-02-21 06:57:03 EST
(In reply to comment #9)
> No, it doesn't work like that. The category page is:
> 
> http://wiki.eclipse.org/Category:BPMN
> 
> If you go there, you will see that I added [[Category:SOA]] on it.
> 
> The SOA category (http://wiki.eclipse.org/Category:SOA) will reference it then.

Ding! The penny drops. So I see you are constructing a hierarchy of
Categories which mirrors the hierarchy of pages, at least for a few
nodes of depth. These seems like a good plan. 

> > It's ok not to have SOA as a category on your page, but I would like it if you
> > had 
> > STP as  a category so that I can  then see all of the STP-related pages just by
> > looking
> > at the category index.
> > 
> > Does that make sense?
> > 
> Yes, it'd be pretty. Ok, so I need to make BPMN a subcategory of STP, and have
> all the wiki pages categorized as STP. :P

Not just pretty, useful too! My brain doesn't work like a wiki you see, and if I can
do an HTTP GET to get a list of all the pages that relate to STP then I can hack up
a client which will draw it all out as a more understandable (to me) tree :)

Comment 11 Antoine Toulmé CLA 2008-02-21 07:41:47 EST
ok, all done.

Can you have a look at this page ?
http://wiki.eclipse.org/index.php?title=Category:STP&action=edit

and write something pretty there.

Thanks!
Comment 12 Oisin Hurley CLA 2008-02-21 08:09:36 EST
(In reply to comment #11)
> ok, all done.
> 
> Can you have a look at this page ?
> http://wiki.eclipse.org/index.php?title=Category:STP&action=edit
> 
> and write something pretty there.


Done!
Comment 13 Antoine Toulmé CLA 2008-02-22 11:32:00 EST
The Infobox template could be useful as well:

http://wiki.eclipse.org/Template:Infobox 

I added it to the BPMN component page.
Comment 14 Oisin Hurley CLA 2008-06-11 22:43:56 EDT
Moved to P1 for Ganymede.
Comment 15 Oisin Hurley CLA 2009-05-14 05:01:18 EDT
*** Bug 265829 has been marked as a duplicate of this bug. ***
Comment 16 Heiko Böttger CLA 2012-09-05 09:49:24 EDT
Deadlinks on http://wiki.eclipse.org/Installing_Headless_Buckminster
404 when trying to download director app, also the text on the page makes it unclear whether this is a updatesite-url or this is a real 404. 

This is not the only deadlink it seems the eclipse wiki and the eclipse.org is full of this links