Bisq Docs Maintainer #29
Comments
2017.12 reportNot much to report this month, save for the fact that @Francewhoa has begun to get involved with the documentation effort (welcome, @Francewhoa!) and may do additional work in the future on guides like bisq-network/bisq-docs#21. Otherwise, I made minor updates to existing docs, and added a couple bounty issues like the one linked above. Note that the Slack chats with @Francewhoa starting here are worth a read for anyone interested, as they lay out a lot of the thinking behind the docs repository and our overall approach here. |
2018.01 reportNo major work done around docs, other than keeping existing docs up to date. We still have outstanding bounties for how-to guides; no takers as yet. |
2018.02 reportNothing to report on docs. Help wanted! Someone who can fully own and take initiative with Bisq's docs could add a lot of value to the network. The ideal docs maintainer would have:
|
|
I just tweeted a link to the above at https://twitter.com/bisq_network/status/968998436463955968. If you're here because of that and think this is something you'd be interested in, read https://bisq.network/phase-zero and come talk to us in |
2018.03 reportThere was very little activity around docs this month, other than the usual maintenance of existing documentation. One thing I've been thinking about now that we've split up the old bisq-network/exchange repository into bisq-common, bisq-core, bisq-p2p, bisq-desktop, etc is whether we want to continue with a dedicated docs repository like we have now, or possibly to move (back) to a |
|
Also interested in this role! |
|
@dsbeasley, thanks for your interest. The best thing to do for a start is to contribute to docs, i.e. submit your own pull requests and review those of others. I know you're already in Slack—let's chat there in the |
2018.04 reportBig changes to docs this month!
These changes were promoted via Twitter to good effect. Also, @m52go has gotten involved, and is in progress producting a Getting Started with Bisq document at bisq-network/bisq-docs#37. In general, all @bisq-network/contributors are encouraged to get familiar with the new docs site, and to begin thinking about it as the place to document all the most important things about Bisq. When we talk about what it means to deliver a contribution, we should always be asking ourselves the question, what needs to change or get added to the documentation such that users can discover and understand my contribution? The docs site is primitive today. You can think of it as something like "a wiki that wants to become a full-fledged manual". For right now, everything is flat. If there is something you want or need to document, come chat about it in From a visual design perspective, the new docs site will be one of the things we want to get aligned with the new design vision coming together with @pedromvpg, @diogorsergio and others. This should be relatively low-hanging fruit, is its' mostly about adapting the existing default Asciidoctor CSS and fonts to align with the new design. This is something I've helped do in previous teams and I can point to that work for a reference point on how to do it. Questions and ideas welcome about this new infrastructure. Let's chat in |
2018.05 reportThe focus on building out https://docs.bisq.network continued this month.
|
2018.06 reportA lot of work in progress this month, but little delivered. Delivered
In progress
|
2018.07 report
I'll include a screenshot like the one below of the monthly analytics overview in these reports from here out if others find it valuable.
BSQ requested: |
2018.08 reportSeveral small updates were made to docs by @m52go in preparation for the v0.8.0 release, and @ManfredKarrer was added as a secondary maintainer so that he could merge PRs when I'm unable to. This month's analytics:
BSQ Requested: |
Cycle 12 ReportMigration to the wiki continued. I added documentation on arbitrators, the burning man, and the arbitration process itself, along with doing a couple of stylistic edits here and there. No changes to the docs repository though. For completeness, here's a screenshot of traffic.
|
Cycle 13 ReportNo activity in the past cycle. Lately I've started to make an intentional effort to get the wiki under control, so that we can get out of this weird no-man's-land it feels like we're currently in (i.e. neither site is an overall authoritative resource) and complete the migration sooner rather than later. The wiki will be getting more traffic soon as a result of wiki articles being linked on the new getting-started page on the website, so it needs to be tidied up anyway. |
Cycle 14 ReportWiki rolled out 3 days ago, so docs can start being decommissioned. A lot of articles have already been transferred. I'm thinking it might be best to convert some of the more notable items like the Phase Zero doc which don't seem appropriate to recreate on the wiki into PDFs. |
Cycle 15 ReportNot much to report. With the wiki now rolled out and most major pages transcribed, I will start linking pages on the front page of the docs website to the wiki. |
Cycle 16 ReportA pull request is in review to start linking docs to the wiki. |
Cycle 17 Report@Bayernatoor and I (but mostly him) are working to transfer DAO docs to the wiki. The PR mentioned in my last report was merged, so many links on the docs front page now point to the wiki. |
Cycle 18 ReportInitiative to transfer DAO docs to the wiki continues. |
Cycle 19 ReportDidn't make any progress on transferring docs to wiki, although I did edit some wiki articles. |
Cycle 20 ReportMight be getting some new help for docs in the new year. Looking forward to shutting down the old docs website in Cycle 21 or 22. |
Cycle 21 ReportNot much to report yet. Announced restart of initiative to move DAO docs to wiki on Keybase; shooting to get it done in Cycle 22. |
Cycle 22 ReportStill looking to get DAO docs moved to wiki before this cycle actually ends. Also want to move website FAQs to the wiki for better maintainability. |
Cycle 23 ReportNot much to report. See Cycle 24 report. |
Cycle 24 ReportThe docs website is now ready to be shut down. We just have to wait for v1.6.5 to be released, which will include PRs (already merged) to remove lingering docs links from the software. After that release has attained good usage, docs.bisq.network can be shut down, and docs.bisq.network can be redirected to bisq.wiki. |
Cycle 25 Reportv1.6.5 was released on May 29, and docs.bisq.network was decommissioned on June 15. |
|
@cbeams this issue can be closed. Although the site is still up, the role is no longer relevant. I recommend shutting the site down too because people still link to it specific pages every now and then, and those page-specific links don't redirect to the wiki. |
|
Closed as requested. I've made a note to self to shut down the site, or to do a global redirect to the wiki. |
|
Update: I've also deleted the @bisq-network/docs-maintainers team accordingly. |
Looks like the 301 redirect was applied to the home page but not all the pages. eg: https://docs.bisq.network/ 301 redirects to https://bisq.wiki/Main_Page ... but for example https://docs.bisq.network/getting-started-dao-traders.html does not redirect. Would it be possible for someone to 301 redirect every page in the docs.bisq.network to the corresponding page on bisq.wiki ? I think every page has been created on the wiki. The reason being is the docs.bisq.network still ranks well is search engines but as it is not longer active some of the information is now outdated. It is not immediately obvious for visitors to docs.bisq.network that it has been retired if they land on a page other than the home page. Occasionally users with support needs reference outdated information on the docs site and it can cause some confusion. Looks like there was an issue created to do so here: bisq-network/bisq-docs#210 I think it would be good to expand the 301 redirect to be site wide. |
That's right. You can see it expressed as the 'Page Rule' with position 1 below:
Yes, this could be done simply by modifying the page rule to include a catch-all asterisk, e.g.:
Unfortunately, this is not directly or cheaply possible. Do have a custom redirect mapping every page on docs to every page on the wiki would require one Page Rule per redirect, and additional Page Rules are a paid feature at Cloudflare. It might be possible to handle the redirect on the wiki side via MediaWiki redirect configuration, but I don't know. If it is possible, then the more inclusive redirect detailed above would be all we need to do on the Cloudflare side. @pazza83, maybe you could look into the possibilities with MediaWiki redirects? @pazza83, let me know if you'd like me to enable the more inclusive redirect. If we do so, it might be also be good idea to relax it from a 301 to a 302. |
Thinking about this a little further, it would be possible to have a per-page mapping if we un-proxied docs from Cloudflare and introduced a This wouldn't be a huge effort. It would consist mostly of:
I'm not sure if that effort is worth it, @pazza83, but if you decide it is and are willing to do (1) and (2) and asking one of the GH admins to do (3) then I can do (4) and (5) and help with (6). |
|
Hi @cbeams thanks for the quick response. Mentioned this issue on today's support call and everyone felt it would be good for this to be actioned to avoid confusion for users. I will action (1) and (2) and then get in touch with a GH admin and update you when it is done. Many thanks |
|
Commenting here as the old docs website has caused some confusion will revisit actioning the above. |
This role is responsible for maintaining the bisq-network/bisq-docs repository, which backs the https://docs.bisq.network site.
Docs: none, other than the above
Team: @bisq-network/docs-maintainers
Primary owner: @m52go
The text was updated successfully, but these errors were encountered: