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

feat(docs): Add a table-of-contents to the docs directory. #1108

Merged
merged 1 commit into from
May 10, 2019

Conversation

rfk
Copy link
Contributor

@rfk rfk commented May 3, 2019

Fixes #869. Rendered.

@rfk rfk requested a review from a team May 3, 2019 04:30
* (although this will soon change to publish to https://maven.mozilla.org).
* There is also a manual step where we mirror artifacts from bintray to maven.mozilla.org,
as a temporary measure until we can get automatic publishing set up correctly.
* Publish it to the [maven.mozilla.org](https://maven.mozilla.org).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated the docs around bintray/maven while I was in here - @eoger r?

@@ -10,7 +10,7 @@ The package is published as a release on github: https://github.com/mozilla/appl

- Add the dependency line to the Cartfile, for instance: `github "mozilla/application-services" ~> "v0.16.1"`
- `carthage` will download MozillaAppServices.frameworks.zip, and add all the available frameworks to the 'Carthage/' dir.
- Choose which framework to link against for your project (in the *Link Binary with Libraries* step in your Xcode target).
- Link against the provided MozillaAppServices.framework (in the *Link Binary with Libraries* step in your Xcode target).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe this needs to change to reflect the fact that we're no longer publishing individual component frameworks on iOS.

@@ -1,36 +0,0 @@
> Android requires that all APKs be digitally signed with a certificate before they can be installed.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe controversial, but...I don't think this doc belongs here. It's specifically about generating apks, which we don't do in this repo, so it wasn't obvious how to link to it from the ToC.

I wonder if there's some more android-product-development-centric place we could move it to?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Perhaps this could live in https://github.com/mozilla-mobile/shared-docs? @vladikoff thoughts?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ref mozilla-mobile/shared-docs#80 for following

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah this doc was useful before, we can move it though, it's okay 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, I don't think we should lose it entirely, it's 👍 content

@rfk rfk force-pushed the docs-table-of-contents branch from 8c959e2 to 4e2ceef Compare May 3, 2019 04:33
Copy link
Member

@linabutler linabutler left a comment

Choose a reason for hiding this comment

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

Thanks for adding this, and for cleaning up the instructions, too!

@rfk rfk merged commit 86f2d46 into master May 10, 2019
@eoger eoger deleted the docs-table-of-contents branch July 10, 2019 18:04
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.

Make a nice table of contents for the docs directory
3 participants