Skip to:
Content
Pages
Categories
Search
Top
Bottom

Codex Posting

  • Avatar of @modemlooper
    @modemlooper
    Moderator

    @modemlooper

    You want to add to the codex, great!

    A couple guidelines to keep the codex in order.

    There are enough top level components, types and contexts to manage all content. Please choose one of the existing options when creating new codex pages. This will keep the codex clean without unnecessary tagging.

    Do not nest pages. The majority of users will google and find the exact page. When nested, if something is move or renamed it will break links.

    The tips, tricks and hacks are not that important. They could cause future problems with sites if code changes do not work. By posting these on bp.org codex it makes them seem official and could confuse a new user. I would refrain from doing these types of posts and stick to documenting the core. In the future we should write the tips on our own blogs/sites/bp forum and then post a link on the main tips/tricks page. If someone has written a how to about a component then place a link at the bottom of the components page like it is done on the WordPress repo (scroll to bottom ) under an External Resources heading with date.

    cc @chouf1

Viewing 7 replies - 1 through 7 (of 7 total)
  • Avatar of danbpfr
    danbpfr
    Participant

    @chouf1

    ok, message received.

    So feel free to delete or move the tips i added today. ;-)

    But if it’s not that  important, can i suggest to remove the whole tips, tricks and code snippet page from the Codex ?
    Even if i’m sure most of the user prefer to go to the Codex first, because it’s the naturally “my issue answer place to be” !

    Or create a dedicated, moderated and well categorized blog for such stuff, because at least it’s annoying to get the  same daily issues querying answers on the support forum.

    Issues, as you know,  are rarely accompanied with the user’s configuration information. So it’s anyway difficult to help in such case. With or without official, uptodated informations, tips or whatever.

    Avatar of @modemlooper
    @modemlooper
    Moderator

    @modemlooper

    I totally understand wanting a place to put the code snippets that can answer those repetitive forum topics.

    The best way is to write a topic in the Creating and Extending forum with title that says what code snippet does and then link to it from the codex. This will allow a discussion to begin on that hack/trick/tip and anyone can include fixes or better ways.

    Then it’s easy to respond to those repetitive topics by linking to the same page in the codex. I will clarify this on the codex tips/tricks page.

    Avatar of John James Jacoby
    John James Jacoby
    Keymaster

    @johnjamesjacoby

    The majority of users will google and find the exact page. When nested, if something is move or renamed it will break links.

    It shouldn’t. Canonical redirect should take care of most cases.

    Avatar of @modemlooper
    @modemlooper
    Moderator

    @modemlooper

    True, but tagging is better for hierarchy. Managing this many nested pages can get crazy.

    Avatar of danbpfr
    danbpfr
    Participant

    @chouf1

    @johnjamesjacoby, @modemlooper,

    one of you decided finally to erase my contributions to the codex. Well ! I invited you to do so if necessary.
    But a private message explaining me your decision would have been appreciated, but it isn’t the case.

    Also, who is responsible of the Codex ? Didn’t know that Ryan is the codex chief editor !

    This tread is also unhelpfull at least.
    The tips & tricks page is still nested with 1 tuto page, despite the tech explanation above.

    And with this on the customize page, i’m very doubtfull too
    Customizing

    This page has no content of its own, but contains some sub-pages listed in the sidebar.
    (between other nested pages “tips & tricks”…)

    Please edit this page and add something helpful! (and probably nested pages too, no ?)

    I thought I was right by adding my tips, even if not on the same page as “Tips – Tricks – Code Snippets” by misunderstanding the existing nesting which is not to use finally ! Sorry for my ignorance of this detail.

    Support users are not code snippets, but real humans. Your method and reaction are simply unbelievable !
    Be sure i’m discouraged and that i don’t add anything to the codex in the 100 next years. :-(

    Dan

    Avatar of @modemlooper
    @modemlooper
    Moderator

    @modemlooper

    What I wrote above are guidelines that are used on the wp.org codex. We should follow the same methods. There are no “hacks” on the WP codex. There is this page http://codex.wordpress.org/Hacking_WordPress. Like that page states, we should encourage plugins. Do not take it personally. There is no “editor” but I’ve spent a great deal of time organizing the pages. The codex is a living body of work and can change. Just because a page is currently nested doesn’t mean it will stay where it is. Somebody yesterday deleted every page in the codex and had to be put back from a backup and that could be why recent pages are not there.

    Avatar of John James Jacoby
    John James Jacoby
    Keymaster

    @johnjamesjacoby

    No one specifically deleted your contributions. Someone was kind enough to wipe the codex of content last night, and I asked for a restore from a few days ago to be done on the codex site’s data.

    Basically, modemlooper spent a bunch of time organizing the codex data, and I’m inclined to let him start setting some rules around what he thinks future contributions look like. That said, we are free to experiment, and we won’t always agree on what’s best. What’s important is that proper feedback is given and we all have a general feeling of it being rewarding to contribute even when your ideas aren’t the popular ones.

    Ask Boone, Ray, and Paul how different our perspectives can be; I think it’s what makes our team so well rounded and great for the project. /tangent

Viewing 7 replies - 1 through 7 (of 7 total)

You must be logged in to reply to this topic.