Documentation update for next release #64
Labels
No Label
blocked
bug
build
documentation
duplicate
enhancement
finger
gemini
gopher
help wanted
http
in progress
invalid
local
needs-info
non-code
non-functional
non-urgent
question
release
rendering
suggestion
telnet
terminal
urgent
wontfix
No Milestone
2 Participants
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: sloum/bombadillo#64
Loading…
Reference in New Issue
No description provided.
Delete Branch "%!s(<nil>)"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
For the next release (2.0.0) we should complete a review of the documentation. This task might involve:
(list amended)
It's likely that this task cannot be completed until all features for 2.0.0 are confirmed.
This is great. I definitely think getting all of this in order is a good call.
For the last question (are there opportunities for consolidation). I have mostly tried to let each piece of documentation serve a specific purpose. My thoughts currently are as follows:
I have made some changes to the branch
update-readme
to bring it more inline with our current state of things. If you get a chance I would love a second set of eyes on it. Feel free to re-word/re-work as you see fit.Thanks for the feedback on this, it matches pretty well with what I was thinking too.
I've made a commit to update-readme but will need some more time on it. I'll continue work on it when I'm next free.
Cool. The changes you made to
update-readme
look good. :)I've reviewed bombadillo.colorfield.space, both web and gopher.
Words like 'opperating' are misspelt on both. the web page also has 'certicicate', the gopher page 'BOMBDADILLO'.
There are a few references to the upcoming changes - version 2 is coming, expect consolidation as we near version 2 - these should change, but I'd recommend removing them anyway, to avoid having to maintain them.
I'm not sure if you would like some more help with this - I can download and modify the pages directly maybe?
You should have repo access if you want to update directly and then I can pull it to the server after it gets merged in. That said, I am definitely able to take care of those and appreciate you finding them. My typing is not always the best, lol. Let me know your preference.
Ok. I went through and updated the spelling mistakes that you mentioned (the ones I was able to find anyway). I did not find much of the 2.0 references with the web version (though it is possible I missed them), but did find a bunch on gopher and removed them in most places. I also made sure that non-web browser was in use.
Thanks for that. I had posted that before I had access to the repo, but did not get to it yet as I have to configure my editor to match the style.
Also, don't forget, you can
:set spell
in vim :)Hahaha. True. I never think of it. I should do so, in particular for content heavy things.
I have added a box at the top of https://rawtext.club/~sloum/bombadillo.html with the following text:
This page contains legacy documentation for Bombadillo 1.0. Please visit bombadillo.colorfield.space for documentation of more recent/current versions of Bombadillo.
That should be satisfactory to make sure people understand that they are looking at old info and get them routed to a new location if that is what they want.
Cool. Also, that box looks really nice.
Thanks!
At what point do you think the website updates should be pushed? We could push now, but there wont be an actual release to tie things to yet... Not sure how the timing should work out to synchronize all of this. I doubt there is a lot of traffic going to the site currently....
It can be put up at any time really, but to be complete it needs 2.0.0 binaries and the 2.0.0 tag.
I just went through the checklist above. If we agree we are at code freeze (which I think we are now), then I can generate binaries and get them added to gopher and to the website.
The code freeze also means that final run-throughs of the man page and README can be done. I'll wait for your comment in response here, but then I'll go through the README to do a final check.
Yeah I think we should be at code freeze now. Exciting!
I have conducted a final reaview of the README. Everything looks good except one incorrect word. I have opened a PR correcting it here: #104 .
That leaves the man page review and binary generation. I believe you had intended to do the man page review.
Once the review is complete I think we should merge into master with a tag 2.0.0 and set it as a release. Then I will generate binaries and get them set up on the gopher and web pages.
At that point we move to announcing the release via notes in issue #72
sloum referenced this issue2019-12-01 03:31:20 +00:00
The executables have been added to gopher and the web. They are zip files containing:
That was the last thing unchecked for this issue. I am closing. Definitely let me know if anything else is spotted that should be done.