foxfirefey: Going to the wiki! (wiki!)
[personal profile] foxfirefey
The wiki now supports embedding Gists from GitHub. (Gists are single version controlled files with easy updating.)

You can see this Gist Test page to see what the syntax is and what the result looks like.
fu: Close-up of Fu, bringing a scoop of water to her mouth (Default)
[personal profile] fu

Here's an expanded, modified version of the original structure I was suggesting.

Paths (/Foo/Bar) are suggested page names / structures. Links are existing pages that seem related and can be used as a base for the new article, or as a base for a subpage of that article.

How do you all feel about subpages? Do you find it helpful in organizing, or will it just make the page names harder to remember?

Note: Categories are helpful for finding everything related, but bare category pages ted to be overwhelming because they're strictly alphabetical order, not priority order, and a category can get pretty broad (e.g., all howtos, even those for a completely unrelated topic), so we need something besides.

I haven't listed all the pages. There are a few groups of pages documenting all the database tables, or a bunch of howtos on closely related topics; I've marked those as "(prefix)".

Despite the number of links, again this is not all that I expect the wiki should contain. But by now I hope that this is enough to make it obvious where additional pages could go.

warning: massive link dump )

fu: Close-up of Fu, bringing a scoop of water to her mouth (Default)
[personal profile] fu

We've been gradually building up articles on the wiki, which is good because wiki == good, but it can be a bit overwhelming for someone new because they won't know where to start.

I propose reorganizing the articles under the Development section: I don't want to constrain things too much, but I think slotting things in more clearly will be helpful for both new and old alike.

We're partway there because of the fine work people have put into Dev Getting Started, but I want to sit down and rethink the split a bit.

What I have in mind is to split up the pages into one-time steps and steps that have to be repeated over and over again, and revise how things are arranged and highlighted in Dev Getting Started. So instead of having a Bugzilla page and a Github page and etc, we have something like the following:

  • front page

    1. Dev Getting Started

      • one-time setup
        • dev environment (scratch installation / getting a hack)
        • bugzilla (registering, username conventions)
        • github (forking etc)
        • CLA
      • working on stuff (the basics)
        • programming guidelines
        • finding things
        • claiming a bug -> submitting a pull request, including conventions etc
        • editing in case of a review
        • updating code (dev maintenance)
    2. Development

      This is more specific resources. Everything under here to be a subpage of /Development?

      • everything in the getting started section
      • submitting hotfixes on a release branch /Development/Release
      • setting up various modules /Development/Setup? Tools? Server?
        • schwartz /Development/Setup/Schwartz
        • gearman
        • search / sphinx
        • memcache
      • howto /Development/Howto
        • new userprop
        • database table (create, edit)
        • edit a database table
        • memcache
        • beta feature
        • enable shop items
        • enable paid time
      • stuff under /admin (/admin/pay, etc)
      • explain stuff under /dev (/dev/classes, /dev/eventoutput, etc)

The examples provided aren't definitive, just examples of what we have and need off the top of my head. There are plenty of articles on the wiki that aren't yet in this list but could fit (most probably under /Development).

Would this structure be helpful for you? What would be most useful to highlight in Dev Getting Started? I'd like to request that we focus on overall structure before specific page suggestions as much as we can, so that it's easier for people to find what they need in the pages we already have.

fu: Close-up of Fu, bringing a scoop of water to her mouth (Default)
[personal profile] fu
  • Dev Getting Started - added Bugzilla workflow before Version Control. Adjusted some text for the long version; changed from mentioning submitting a patch to "version control"

  • Bugzilla workflow - removed the patch upload instructions and just link to Version Control

fu: Close-up of Fu, bringing a scoop of water to her mouth (Default)
[personal profile] fu

I'm updating documentation to remove mentions of Mercurial and replace with resources for Git. I'm also trying to go through the flow of pages, starting from the main page, hopefully figuring out what someone new to the project will click on...

Right now I'm doing a depth-first traversal of links, starting from the "Dreamwidth Developers" section of the main page.

  • Dev Getting Started - changed paragraphs to a list for easier scannability. Moved stuff from the intro at the top to a "what you need" section / removed the two paragraphs on installing a dev environment since they somewhat are repeated below or in other pages.

  • Bugzilla - made the link to workflow more visible, removed needs-review / needs-commit from saved searches

  • Dreamwidth Scratch Installation - adjusted references from etc/config* to ext/local/etc/config*; removed paragraphs from the "Starting development section", instead linking back to "Dev Getting Started" to centralize

  • Main development folder - moved to Directory Structure

  • Dev Patches - obsolete, deleted. Will replace anywhere that refers to this to the git workflow

  • Draft: Github development process - forward to Version Control

  • Version Control - replace with old contents of Github development process

Stopping for now; have worked my way through the links at http://wiki.dwscoalition.org/wiki/index.php/Dev_Getting_Started through to the end of "The short version"

I'll post further changes in another entry.

foxfirefey: Going to the wiki! (wiki!)
[personal profile] foxfirefey
It's that time again--I'll be upgrading Mediawiki to 1.20 over the next few hours, so if you run into problems after I've updated this post to indicate the upgrade is complete, please let me know!

ETA: The update is complete--keep me posted on any issues you have!
exor674: Computer Science is my girlfriend (Default)
[personal profile] exor674
I am thinking we are lacking in documentation for more production-like setups including [ and I am probably missing things here ]:

  • resource concatenation
  • clustered setup
  • cron jobs for maint scripts + recommended schedule ( which need daily, which weekly, which whenever, etc.. )
  • running purges
  • ... I am probably missing more things...
foxfirefey: A guy looking ridiculous by doing a fashionable posing with a mouse, slinging the cord over his shoulders. (geek)
[personal profile] foxfirefey
So, as you may/may not know, we are in the process of moving our source control and development process over to git in order to take advantage of Github.

What we need to do is go through our documentation and change:

* Links to the old hg.dwscoalition.org repository to their new equivalents on https://github.com/dreamwidth/dw-free
* Descriptors that refer to cvsreport.pl, which no longer exists, especially in update contexts
* Installation instructions
* Documentation on code layout--cvs directory no longer exists, for example

And anything else that we can think of. The Development category is in need of special attention.

We also need to start creating best practice policies (for instance, do development on branches your create) and putting them onto the wiki. We do have one new page with a first draft of instructions so far on:

Moving your Dreamwidth installation to use Github

Feel free to comment on this post with anything you see that needs updating, if you don't feel like updating it yourself!
foxfirefey: Going to the wiki! (wiki!)
[personal profile] foxfirefey
Okay folks, the server the wiki is on is horrible out of date, and badly in need of an upgrade. I'll be doing it sometime today--if the wiki is down when you need it, I am sorry! It will be back soon.

Update: The server OS and the wiki software have both been updated to recent versions. There may be some problems to work out still, as Special:SpecialPages is erroring out.

Update 2: Tracked down the erroring out to the OpenID extension, which is now properly updated.
foxfirefey: A wee rat holds a paw to its mouth. Oh, the shock! (thoughtful)
[personal profile] foxfirefey
Previously, I think I disabled regular account creation, and that let OpenID accounts register. This kept away spammers, but still let grandfathered accounts work by logging in using their passwords.

This strategy no longer works and I need to figure out a new one. The OpenID plugin has a setting to only allow OpenID logins, but that then blocks out non-OpenID users. In the meantime, registration is turned off because I can't keep dealing with the many, many spam registering accounts that have been constantly happening since I turned regular registration on. There might need to be Captchas, or some other strategy.
foxfirefey: A guy looking ridiculous by doing a fashionable posing with a mouse, slinging the cord over his shoulders. (geek)
[personal profile] foxfirefey
I've been putting it off but it needs to be done--expect the wiki to be askew until I finish (or give up and restore the backups until I can figure out what went wrong)! Upgrade is finished!

Upgrade Notes

  • SemanticQueryFormTool can't be used anymore with the most recent version of Semantic Mediawiki
  • Right now it's on the default MW skin and I took one of the icons to use for the logo. I'm very very open to new logos--the size to shoot for is 135px by 135px. I might tweak the CSS for the skin a little, but mostly I'll keep to the standard.

If you can go test out the wiki and make sure you can log in, that would be dandy!

foxfirefey: Dreamwidth: social content with dimension. (dreamwidth)
[personal profile] foxfirefey
Replicating this [site community profile] dw_dev_training post on Dreamzilla and wiki documentation bugs, this post is to tell you there is a brand new section for development and volunteering documentation on the wiki.

To filing a new bug in this category, select "Project Documentation" as the product and "Wiki documentation" as the component.
pauamma: Cartooney crab holding drink (Default)
[personal profile] pauamma
So I've been writing and or uodating a series of wiki pages(*), often in pairs for setting up foo and using foo in your code. Titles so far follow the "Setting up Foo" (which may also covers installing, starting/stopping, and troubleshooting) and "Foo" (which covers up writing code for or using in Dreamwidth code).But now, I'm wondering whether that's the best nomenclature and considering renaming "Foo" pages to "Using Foo in code" or something similar. I don't think it's worth having an extra Foo page for that, as it would just link to both and have little content of its own. However, that makes it hard to link to both, when you don't know what information the reader is most likely to want. So I'm considering using [[Category: Foo|Foo]] instead, for those links. What do you guys think?

(*) So far, TheSchwartz is done, Gearman is next (haven't started), and when I'm done I may do Memcache and MogileFS.
pauamma: Cartooney crab holding drink (Default)
[personal profile] pauamma
Should http://www.dreamwidth.org/dev/classes be mentioned/moved/duplicated in thw wiki? Where, if so?
afuna: Cat under a blanket. Text: "Cats are just little people with Fur and Fangs" (Default)
[personal profile] afuna
I was about to update the protocol documentation, and found that we have two pages for it:

http://wiki.dwscoalition.org/notes/XMLRPC_Protocol
http://wiki.dwscoalition.org/notes/XML-RPC_Protocol

The latter is lots more comprehensive, but the former has some interesting semantics code in the source, which I'm not sure how to port over.

Thoughts?
foxfirefey: Dreamwidth: social content with dimension. (dreamwidth)
[personal profile] foxfirefey

Hello, folks! I have upgraded the wiki to version 1.16 of Mediawiki. Let me know if you run into any weirdness.

I also feel like I should note that I have modified an extension for the browser editor jEdit to let people edit the Dreamwidth wiki using it. Is anybody interested in me distributing this? Let me know!

foxfirefey: Going to the wiki! (wiki!)
[personal profile] foxfirefey
Today, the wiki's been down for short periods of time because of a power circuit issue at my host. They're looking into it and making sure it gets totally fixed.
invisionary: "When I give food to the poor, they call me a saint.  When I ask why the poor have no food they call me a communist." (Default)
[personal profile] invisionary
As most of you know, the Wiki is available space for any information related to the DW project. However, it's been around for quite some time and as such there's a lot of outdated information. We need to clean this up so that the Wiki remains a useful resource for developers and other volunteers. You can help!

There's three things that will greatly help us with this rather large task.

* Update articles to make them useful. There's all sorts of ways to browse them - use the Wiki Toolbox to find some if you need.

* If you don't have the information to update it, but know it needs updating, add this textbox to the top of the page: http://wiki.dwscoalition.org/notes/Template:Obsolete - use the tag {{subst:Obsolete}} (subst adds the correct date stamp).

* If you think a page should just be deleted entirely, add this box to the top of the page: http://wiki.dwscoalition.org/notes/Template:Deletion_Request - use the tag {{subst:Deletion Request}} - an admin will review the request and either remove the page or the box (and leave a talk entry if appropriate).

Myself or [personal profile] foxfirefey can elevate privs on the Wiki if there is some function that would be useful to you that you don't have.

Thanks for all that you do.

Wiki: http://wiki.dwscoalition.org/notes
foxfirefey: Fox stealing an egg. (Default)
[personal profile] foxfirefey
Recently we've been hit with a vandalbot. They're really common on wikis--they just insert gibberish into pages, or replace real page content with gibberish. It looks like the Bug Report Workflow (Support) got onto their lists and they keep editing gibberish into that page, so I have protected that page so that only non-new registered users can edit it. You can see an example of vandalism here.

It'd be good for folks to keep an eye on the Recent Changes page for other vandalbot activity. If you know how to rollback changes, feel free to, but comment here if you don't. It might also be good to comment here if you do, to keep track of this issue. If they start hitting a wide variety of pages, we might have to look into deterrence methods (like setting it up so that ReCaptcha triggers on all edits by nonregistered users).
cesy: Home is where the <3 is (Dreamwidth) (Dreamwidth)
[personal profile] cesy
I just noticed http://wiki.dwscoalition.org/notes/Wiki_Tasklist. Which other volunteering pages is it worth linking this from, and does it need any updates?

For instance, http://wiki.dwscoalition.org/notes/From_LJ_Suggestions includes a task list, so should probably be linked from that page.

Profile

dw_wiki: Going to the wiki! (Default)
Dreamwidth Wiki Management

November 2016

S M T W T F S
  12345
6789101112
13141516171819
2021222324 2526
27282930   

Syndicate

RSS Atom

Most Popular Tags

Style Credit

Expand Cut Tags

No cut tags