Skip to content

Publish developer docs#2622

Merged
fisx merged 28 commits intodevelopfrom
publish-developer-docs
Aug 24, 2022
Merged

Publish developer docs#2622
fisx merged 28 commits intodevelopfrom
publish-developer-docs

Conversation

@fisx
Copy link
Contributor

@fisx fisx commented Aug 16, 2022

https://wearezeta.atlassian.net/browse/SQSERVICES-1724

Checklist

  • Make sure you've incorporated all changes introduced between a0efd6a and develop.
  • The PR Title explains the impact of the change.
  • The PR description provides context as to why the change should occur and what the code contributes to that effect. This could also be a link to a JIRA ticket or a Github issue, if there is one.
  • changelog.d contains the following bits of information (details):
    • A file with the changelog entry in one or more suitable sub-sections. The sub-sections are marked by directories inside changelog.d.

@fisx fisx temporarily deployed to cachix August 16, 2022 20:33 Inactive
@fisx fisx temporarily deployed to cachix August 16, 2022 20:33 Inactive
@zebot zebot added the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Aug 16, 2022
@fisx
Copy link
Contributor Author

fisx commented Aug 16, 2022

ping @smatting

@fisx
Copy link
Contributor Author

fisx commented Aug 16, 2022

  • still struggling with rst / md syntax and semantics
  • not sure if i want to keep /docs/{developer,reference,legacy}/... as links or text references to the new urls. if we keep them, they will likely deteriorate (see next point), but they may still point roughly into the right direction.
  • i am pretty confident i don't want to change the structure or contents of what i've moved any further; that should be work for future PRs.

@fisx fisx temporarily deployed to cachix August 17, 2022 14:56 Inactive
@fisx fisx temporarily deployed to cachix August 17, 2022 14:56 Inactive
@arthurwolf
Copy link
Contributor

note: go through all references in index/toc and turn # into ##, should fix some warnings

Co-authored-by: yupri <69316518+yu-pri@users.noreply.github.com>
@fisx
Copy link
Contributor Author

fisx commented Aug 22, 2022

@arthurwolf if you want to resolve the conflicts, you may want to look at what i've tried to do and just start over from the new tip of develop, to make sure you're not missing anything from the old places.

use this PR and force-push something that works, or use a new branch and PR and close this one, whatever's easier for you.

(or you can just give me the proof of concept here and i'll try to find the time to clean it up later.)

@fisx fisx temporarily deployed to cachix August 24, 2022 12:57 Inactive
@fisx fisx temporarily deployed to cachix August 24, 2022 12:57 Inactive
@fisx fisx marked this pull request as ready for review August 24, 2022 12:57
@fisx fisx requested a review from arthurwolf August 24, 2022 12:58
@fisx
Copy link
Contributor Author

fisx commented Aug 24, 2022

I would merge this as-is since it's a clear improvement, but here is another thing about rst that gets me mad:

2022-08-24-145428_1920x1080_scrot

On https://docs.wire.com/developer/developer/index.html (or /docs/src/developer/index.rst), some of the links in the TOC are labelled with the title of the sub-page, some with the file name (which I am explicitly giving in the TOC, and would expect to be used). I can't find the difference in the code that triggers this difference in behavior.

I'll keep staring at it for a little while longer, but @arthurwolf maybe you have an idea? But more importantly please see if you think it can be merged. I want to wrap this up.

Thanks for all your help with this!

@smatting smatting temporarily deployed to cachix August 24, 2022 15:39 Inactive
@smatting smatting temporarily deployed to cachix August 24, 2022 15:39 Inactive
@smatting
Copy link
Contributor

The TOC seems to get broken if there are multiple top-level headings in the markdown files. I fixed the heading levels in all the markdown files and added the developer/ reference/ structure with this result:

image

Also I removed all tombstone links.

@smatting smatting self-requested a review August 24, 2022 15:43
@fisx fisx merged commit 89e093e into develop Aug 24, 2022
@fisx fisx deleted the publish-developer-docs branch August 24, 2022 19:12
@fisx fisx mentioned this pull request Aug 24, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants