Removing common recipes

13 messages

Mikko Ohtamaa () Removing common recipes

Reply Threaded

Hi,

Could someone please clear/delete all pages in:

http://plone.org/documentation/tutorial/manipulating-plone-objects-programmatically/

I cannot do it (don't know why). Permission problem?

The information is old and partially just confuses the reader.

The information is superseded by Plone Developer Manual. The link for new developer-manual work-in-progress version is:

http://plonemanual.twinapex.fi/

This will be migrated to plone.org in some point. The point being, when there is more than one active maintainer for the documentation, besides me, and we have necessary PHC infrastructure done.

-Mikko

vedaw () Re: Removing common recipes

Reply Threaded

Some javascript/style in this post has been disabled (why?)

Re: [Plone-docs] Removing common recipes

Sure you don't want us to just mark it as outdated and / or private? I'd
hate to delete it then find out you needed something...

On 10/15/09 5:09 PM, "Mikko Ohtamaa" <[hidden email]> wrote:

>
> Hi,
>
> Could someone please clear/delete all pages in:
>
> http://plone.org/documentation/tutorial/manipulating-plone-objects-programmati
> cally/
>
> I cannot do it (don't know why). Permission problem?
>
> The information is old and partially just confuses the reader.
>
> The information is superseded by Plone Developer Manual. The link for new
> developer-manual work-in-progress version is:
>
> http://plonemanual.twinapex.fi/
>
> This will be migrated to plone.org in some point. The point being, when
> there is more than one active maintainer for the documentation, besides me,
> and we have necessary PHC infrastructure done.
>
> -Mikko

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

JoAnna Springsteen () Re: Removing common recipes

Reply Threaded

On Thu, Oct 15, 2009 at 8:13 PM, Veda Williams <[hidden email]> wrote:
> Sure you don't want us to just mark it as outdated and / or private? I'd
> hate to delete it then find out you needed something...

don't delete. private and/or outdated please! save for posterity.

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Anne Bowtell-3 () Re: Removing common recipes

Reply Threaded

In reply to this post by Mikko Ohtamaa

> http://plonemanual.twinapex.fi/
>
>

This is really fantastic. Thanks Mikko!

Anne

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Kurt Bendl () about "developer-manual work-in-progress" and release versions

Reply Threaded

In reply to this post by Mikko Ohtamaa

Hi folks,

First: http://plonemanual.twinapex.fi/ == Awesome!

Mikko's comment about some content being "old"
and "confusing" is spot-on. Version soup.

I would really like to see documentation separated
by version moving forward, e.g.,
["/docs/3.3/*", "/docs/4.0/*","/docs/4.1/*", "/docs/5.0/*"]

When a new version rolls out, copy with the previous
version (if appropriate), stick it in a new folder,
and make changes where appropriate. I believe this
approach works more like people think. Well, at
least it work more like I think. Disk space is cheap.
Let's take advantage of it. :-)

Other successful open source projects do this
(apache and python come to mind) and it "just works".

I believe http://plonemanual.twinapex.fi/ is a perfect
candidate for this.

Opinions?

/me ducks for cover
:-)

-Kurt

On 10/15/2009 08:09 PM, Mikko Ohtamaa wrote:

> The information is old and partially just confuses the reader.
>
> The information is superseded by Plone Developer Manual. The link for new
> developer-manual work-in-progress version is:
>
> http://plonemanual.twinapex.fi/
>
> This will be migrated to plone.org in some point. The point being, when
> there is more than one active maintainer for the documentation, besides me,
> and we have necessary PHC infrastructure done.
>
> -Mikko

Kurt

--
Kurt Bendl - ITD
4075 Elmwood Ave.
Louisville KY 40207
Phone: 720-633-8665
Fax: 888-824-3131

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Mikko Ohtamaa () Re: about "developer-manual work-in-progress" and release versions

Reply Threaded

Kurt Bendl wrote:

I would really like to see documentation separated
by version moving forward, e.g.,
["/docs/3.3/*", "/docs/4.0/*","/docs/4.1/*", "/docs/5.0/*"]

This would be great. However I don't expect this happen in any time soon. Plone community has its hands full to learn to do development documentation at all. As long as people are not committed to do proper API documentation and as long as the most of the code base consists of old, undocumented, Zope 2 based components, this is just something you can dream on.

It is unnecessary difficult for a third party to figure out when a particular function was added or removed unless that is being documented in the code itself.

-MIkko

Mikko Ohtamaa () Re: Removing common recipes

Reply Threaded

In reply to this post by vedaw

vedaw wrote:

Sure you don't want us to just mark it as outdated and / or private? I'd
hate to delete it then find out you needed something...

Now it is obsolete meaning that no one can access to doc in the first place (except doc team, owner).

I set all pages to hidden. There is one published page with note to go to look for new documentation. However, this page is not available for visitors by workflow rules?

-Mikko

vedaw () Re: Removing common recipes

Reply Threaded

If you want to hide all of the pages that are out of date and have a single
page that tells people to look in the new location, that's fine by me for
the short term, but I think it's a little non-standard for doc team
practices.

When do you think you could move the developer manual onto Plone? If we
could do that easily, it would eliminate the need for that page telling
people where to look.

Thanks!

- Veda

On 10/16/09 11:06 AM, "Mikko Ohtamaa" <[hidden email]> wrote:

>
>
>
> vedaw wrote:
>>
>> Sure you don't want us to just mark it as outdated and / or private? I'd
>> hate to delete it then find out you needed something...
>>
>
> Now it is obsolete meaning that no one can access to doc in the first place
> (except doc team, owner).
>
> I set all pages to hidden. There is one published page with note to go to
> look for new documentation. However, this page is not available for visitors
> by workflow rules?
>
> -Mikko

vedaw () Re: Removing common recipes

Reply Threaded

In reply to this post by Mikko Ohtamaa

Ah, I see... It's open edit on your doc. I see... This presents an
interesting dilemma for us, because we intend for the new Knowledgebase to
be open edit, but not manuals.

Editors?

On 10/16/09 11:06 AM, "Mikko Ohtamaa" <[hidden email]> wrote:

JoAnna Springsteen () Re: Removing common recipes

Reply Threaded

If it's to remain an openly editable doc, then it'll go in the KB.
We should probably not call it a manual though, so people aren't confused.

J.

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs

Mikko Ohtamaa () Re: Removing common recipes

Reply Threaded

In reply to this post by vedaw

vedaw wrote:

When do you think you could move the developer manual onto Plone? If we
could do that easily, it would eliminate the need for that page telling
people where to look.

Not very time soon, but "on some day" :) I am planning to live to see that day.

* The document needs to be open edit, as there is no way one or few persons can maintain the amount of information as happened with "Common Plone recipes"

* The document uses Sphinx styles (XML code, Python code, warning, note) for which there is Plone direct equivalents

* Probably the structure of the document does not directly map to PHC conventions

* Knowledge base is still far in the horizon I assume?

-Mikko

vedaw () Re: Removing common recipes

Reply Threaded

KB is hung up until Limi and I can sort through the designs. We're working
towards spending some time to hash this out, but it's not going to happen
before conference. Things are just moving too fast right now...

After that, the KB is pretty much free-form and you can do whatever you
want. It would be nice to have a structured manual if possible, but we'll
burn that bridge when we get to it.

On 10/16/09 12:48 PM, "Mikko Ohtamaa" <[hidden email]> wrote:

>
>
>
> vedaw wrote:
>>
>> When do you think you could move the developer manual onto Plone? If we
>> could do that easily, it would eliminate the need for that page telling
>> people where to look.
>>
>
> Not very time soon, but "on some day" :) I am planning to live to see that
> day.
>
> * The document needs to be open edit, as there is no way one or few persons
> can maintain the amount of information as happened with "Common Plone
> recipes"
>
> * The document uses Sphinx styles (XML code, Python code, warning, note) for
> which there is Plone direct equivalents
>
> * Probably the structure of the document does not directly map to PHC
> conventions
>
> * Knowledge base is still far in the horizon I assume?
>
> -Mikko

Encolpe DEGOUTE () Re: Removing common recipes

Reply Threaded

In reply to this post by JoAnna Springsteen

JoAnna Springsteen a écrit :
> On Thu, Oct 15, 2009 at 8:13 PM, Veda Williams <[hidden email]> wrote:
>> Sure you don't want us to just mark it as outdated and / or private? I'd
>> hate to delete it then find out you needed something...
>
>
> don't delete. private and/or outdated please! save for posterity.

Yes please don't delete old documentation.
Yesterday I meet a developer that is working on a Plone 1 trying to
migrate it on Plone 3. Without old documentation she cannot find clues
to create an export.

We can turn outdated documentation into static html files and prepare
archives easy to download but we should not delete it.

Regards,
--
Encolpe DEGOUTE
http://encolpe.degoute.free.fr/
Logiciels libres, hockey sur glace et autres activités cérébrales

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs