On Sun, Jan 29, 2017 at 04:24:39AM -0700, brynn wrote:
#2 - Strictly user-facing pages in the wiki are moved to the main
website. High level project info, roadmaps, user-oriented FAQs, community resources, and so on. If a page requires advanced styling or layout functionality in our current mediawiki, that would be a strong indication it should be moved to our Django. This will obviously take time and effort but can be tackled bit by bit. Most of this is worth translating. Finalized release notes will become part of the releases app; this will support html and translations.
I'm not as familiar with the wiki as Maren, but as far as I know #2 is almost completely finished.
Ok, great. In poking around a bit I see a lot of wiki pages being properly marked as no longer relevant, with pointer to an appropriate page on the Inkscape website. So this all looks quite good.
The only user-facing info still in the wiki, that I know of, is the Extension Repository page. It's kind of in limbo right now, because it's part of the project which Mark Schafer is working on, to get as many extensions as possible uploaded to InkSpaces/gallery (and he and Maren, and to a much lesser extent, me, are using the wiki for that).
Ok cool. I like that in the gallery that there is an example image or video for each extension. The descriptions look a bit more complete too.
There's a fair bit of other extension-related information in the wiki currently, beyond details on extensions themselves. But I suspect most of that can be folded into some of the other described sections. For instance, docs related to how to write extensions probably would be best housed in a developers' manual.
I'm not sure about Roadmaps being user-facing. But I guess there are some pages which are benficial to both sides (user/developer). But if it is user-facing, I don't think it's on the website yet. About putting it on the website, I'd worry it might generate complaints, unless it's strongly worded in the introduction about how it's set more in jello than stone.
I do need to go through and revamp it majorly, I haven't worked on it in years and I'm sure it's completely inaccurate. And you're right it's of interest to everyone, it's not strictly just user-facing. But it is high profile and the range of people who need to edit it are relatively limited so for these reasons I think the website is a more appropriate home for it. Anyway, for now let's not worry about it. When I get around to updating it we can take another look at placement.
Hhmm....I see those user-facing pages still have not been deleted! I deleted them once, after I put the info on the website (on Martin's ok) but they came back. Then we learned that there is some upper-level wiki editor which (or who?) doesn't allow pages to be deleted. But I thought we finally solved that, and had deleted them. I guess not.
The approach of leaving them in place but link to the replacement page in the website seems suitable. I wonder if there's a subtle way we could mark links on the top page of the wiki to indicate these kinds of pages.
(On the main wiki page, the User Documentation section, the link to "International and Local Communities" probably should link to the Community page on the website. Just like "Tutorials" links to the Learn page. Seems like I fixed that once before, myself....hhmm.)
Bryce
All best, brynn
-----Original Message----- From: Bryce Harrington Sent: Sunday, January 29, 2017 1:36 AM To: inkscape-devel@...6... Subject: [Inkscape-devel] [RFC] Wiki replacement plan
I'd like to offer a proposal for a path forward here, merging ideas and concerns everyone's put in, particularly Maren's feedback on my initial proposal in the previous wiki thread. Apologies ahead of time for the length, as usual brevity escapes me.
Wiki Replacement Plan
#0 - No change to the current wiki until Inkscape's codebase is migrated to git. So, probably no change until March or so. Thus, people considering using the wiki for things right now, should proceed with doing those things.
#1 - Application documentation and reference source files are moved to Inkscape's share directory in VCS. Extension references, output format details, tutorials, usage advice, and so on. This will be shipped with the application, and probably worth rendering in some web-viewable format as well. Nearly all of this will be worth translating.
#2 - Strictly user-facing pages in the wiki are moved to the main website. High level project info, roadmaps, user-oriented FAQs, community resources, and so on. If a page requires advanced styling or layout functionality in our current mediawiki, that would be a strong indication it should be moved to our Django. This will obviously take time and effort but can be tackled bit by bit. Most of this is worth translating.
Finalized release notes will become part of the releases app; this will support html and translations.#3 - Static coder-facing documentation should be moved to Inkscape's doc/ directory. This includes anything that documents implemented designs, protocols, and other assorted functionality. It also includes coder tutorials and guidelines. Generally materials that can be considered "finished" and worth keeping for reference value. This doesn't include unimplemented ideas/proposals, nor anything that is obsolete or that we're keeping simply for historical purposes. Little of this will be worth translating.
#4 - Dynamic development pages are moved to the git*b wiki. This includes design mockups, development plans, todo lists, architectural brainstorming, infrastructure refactoring proposals and the like. A lot of the stuff currently registered as blueprints, that are adequately well fleshed out and that may be worth including in our official roadmap, should also move here. None of this should be translated.
The release notes under development for the trunk codebase are drafted here in this wiki. Perhaps eventually we'll move editing to the releases app. This also includes organizational documentation for the Inkscape board, pages relating to fundraising, hackfest planning, and so on.#5 - Obsolete pages are left in the current wiki, but "mothballed" for historical reference.
#6 - A "Community Wiki" will be established with open access for members of the wider Inkscape community, to use as a freeform collaborative editing space. There would not be rules about what can and can't go in here, but this is where folks would go to do collaborative brainstorming, flesh out raw ideas, and share random wishes and bits of information not ready or suitable for inclusion in any of the above. It should be easy to register for and easy to edit, but also robust against spam. All other pages not covered by 2-5 above, will end up here.
As a general rule of thumb, if a page in the Community Wiki is important enough to be worth translating, or if we find ourselves linking to the page frequently, then that is a sign the page ought to be promoted and moved elsewhere. This could be an updated MediaWiki like we currently have, however I'd like to see thought given to alternative solutions, such as a Django wiki plugin that allows tighter integration with the website, or even using an externally maintained wiki service. It could also be a special Git*b project with really lax rules for committing. Whatever we pick, the important things are that it's widely available to all, easy to use, and very light on rules or imposed structure.#7 - Feature requests and wishlist changes, eventually will move into a future project management system on the website (I envision something that couples bug tracker style commenting with wiki like editing within a Blueprints-type tracking system). This is probably a few years out though so we'll need to keep using #4 devel wiki in the meantime.
Let me know what you think, and please poke holes. If there are no red flags raised, we can proceed with this plan subsequent to our move to git.
Thanks, Bryce
Check out the vibrant tech community on one of the world's most engaging tech sites, SlashDot.org! http://sdm.link/slashdot _______________________________________________ Inkscape-devel mailing list Inkscape-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-devel