Arvados

23407-wiki2doc @ 43680af16ad4aadd597d376273c2cecb162d7c27

This branch prepares for the retirement of Redmine in two ways: it advertises GitHub as the place to file issues and make pull requests; and it imports important wiki documentation to doc/development. I did some documentation updates while I was at it just because I felt motivated.

This is a relatively large branch that could get even larger. Here's what I think in scope for review for this branch:

• Problems with the markup conversion (if you notice small issues, feel free to make those directly and push changes)
• Documentation that I added or edited or needs improvement in some way, including overlooking referencs to Redmine

The documentation could always be better. Here's what I think is not in scope:

• Removing Redmine references scattered throughout the source. This will be a separate branch, partly because some of this might appear in code like log messages, etc. I want to minimize risk in this branch.
• Updates or expansion to documentation that I did not update, merely imported. Documentation updates can always be done in separate tickets. There will definitely be one for the release process.

With that said:

• All agreed upon points are implemented / addressed. Describe changes from pre-implementation design.
  • See above
• Anything not implemented (discovered or discussed during work) has a follow-up story.
  • See above
• Code is tested and passing, both automated and manual, what manual testing was done is described.
  • In addition to doc tests above, I have at least manually rendered some Markdown to HTML and spot-checked it.
• Tested code incorporates recent main branch changes.
  • Yes
• New or changed UI/UX and has gotten feedback from stakeholders.
  • N/A
• Documentation has been updated.
  • Yes
• Behaves appropriately at the intended scale (describe intended scale).
  • N/A
• Considered backwards and forwards compatibility issues between client and server.
  • N/A
• Follows our coding standards and GUI style guidelines.
  • Yes

Hi, first of all thank you for doing a lot of cleanup and revisions to the current docs!

I pushed a branch 23407-wiki2doc-revisions at 847be3f558de4f73e4245668cd8fe323fd44e912 for your easy diffing.

The following commits mostly contain changes to the content that you've written for this ticket (it might be helpful to view them with git diff --word-diff:

• 37814fcbfb227bf3b011f9fbddf210df0e4e18f5 (Prerequisites.md; I revised the content based on my experience following your instructions setting up a Debian Trixie dev environment)
• 9d5a205d72811618ee6cb8c7fe5215f38468d2dc (RunningTests.md)
• f813301025700b6dead1769c6ebb4849e4bf645a (DevelopmentProcess.md)

while the following, dealing with the MD files under release/, are mostly about fixing import problems:

• f903a89cf1d4fb0f800bfce9b52beb82981839e5
• 847be3f558de4f73e4245668cd8fe323fd44e912

The last one is pretty big because the HTML table in Checklist.md was missing quite a bit of table-cell content (I saw that the original Redmine wiki source had multi-line cells, but GH-markdown [or all markdowns?] can only handle simple table cell content natively). There were also unconverted internal links that needed fixing, so I added relative links to the new MD files for them. Finally just to reduce the strain on my eyes (and hopefully be useful for future human-initiated content revisions to this table), I added some indentation to the table elements in the file -- let me know if this is welcome.

I also considered using GH-markdown native tables for that big table, but again it's unwieldy to do tables with long lines and block elements in the cells, so I didn't do that.

These commits are just my suggestions and I'll leave it to you to decide what to do for each file that appear in the diffs. Thanks!