Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update docs for modern version of autopush #388

Merged
merged 13 commits into from
Jul 12, 2023
Merged

Conversation

jrconlin
Copy link
Member

@jrconlin jrconlin commented Jun 8, 2023

Rewriting/supplementing docs for autopush to match current system.

TODO:

  • add tables of contents
  • docker-compose / dockerfile updates Making own issue.
  • Makefile updates for mdbook~ using github actions to generate the book into pages.

Issue: SYNC-3393

WIP

Rewriting/supplementing docs for autopush to match current system.

TODO:
 -[ ] add tables of contents
 -[ ] docker-compose / dockerfile updates
 -[ ] Makefile updates for mdbook

Issue: SYNC-3393
@jrconlin jrconlin requested a review from pjenvey June 13, 2023 21:30
@jrconlin jrconlin marked this pull request as ready for review June 13, 2023 21:30

## Changelog

[Changelog](https://github.com/mozilla-services/autopush/blob/master/CHANGELOG.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Changelog](https://github.com/mozilla-services/autopush/blob/master/CHANGELOG.md)
[Changelog](https://github.com/mozilla-services/autopush-rs/blob/master/CHANGELOG.md)

Comment on lines 73 to 74
</div>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
</div>

Comment on lines 102 to 103
</div>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
</div>

Copy link
Member

@pjenvey pjenvey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wanna add a status badge to the top level README that points to where these docs will end up? Or do it later?

@@ -0,0 +1,110 @@
Release Process {#releasing}
===============

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one's outdated, wanna just add a warning for now?

Suggested change
> **WARNING**: This page is outdated

@jrconlin
Copy link
Member Author

Yeah, I was thinking that I'd update the README with the link, once we know that the pages are generated and live.

@jrconlin jrconlin merged commit d36fb52 into master Jul 12, 2023
1 check passed
@jrconlin jrconlin deleted the docs/SYNC-3393_docs branch July 12, 2023 22:24
@jrconlin jrconlin mentioned this pull request Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants