Skip to content

Commit

Permalink
Android guidelines restructuring (#2324)
Browse files Browse the repository at this point in the history
* Merged Android's introduction.md with design.md and removed a reference to the former from general_sidebar.yml

* Updated implementation.md to follow the new guidelines structure.

* Updated design.md with PR suggestions

* Updated design.md and implementation.md with PR suggestions. Added a couple links to refs.md

* Added more changes from PR feedback.

* Changes reference in includes_/refs.md from introduction.md to design.md for Android.

* Removed a point about sync streaming methods based on PR feedback.

* Changed the reference to the Android Guidelines entry point wherever required.
  • Loading branch information
vcolin7 authored Feb 18, 2021
1 parent 528a51d commit a091066
Show file tree
Hide file tree
Showing 10 changed files with 516 additions and 582 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ contact [[email protected]](mailto:[email protected]) with any additio
[![Github.io linkchecker](https://img.shields.io/azure-devops/build/azure-sdk/internal/1620?label=github.io%20linkchecker)](https://dev.azure.com/azure-sdk/internal/_build/latest?definitionId=1620&branchName=master)

[General Design Guidelines]: https://azure.github.io/azure-sdk/general_introduction.html
[Design Guidelines for Android]: https://azure.github.io/azure-sdk/android_introduction.html
[Design Guidelines for Android]: https://azure.github.io/azure-sdk/android_design.html
[Design Guidelines for .NET]: https://azure.github.io/azure-sdk/dotnet_introduction.html
[Design Guidelines for Go]: https://azure.github.io/azure-sdk/golang_introduction.html
[Design Guidelines for C99]: https://azure.github.io/azure-sdk/clang_design.html
Expand Down
6 changes: 1 addition & 5 deletions _data/sidebars/general_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -125,14 +125,10 @@ entries:
external_url: https://azure.github.io/azure-sdk-for-js/storage.html#azure-storage-queue
- title: Android Guidelines
folderitems:
- title: Introduction
url: /android_introduction.html
- title: API Design
- title: Design
url: /android_design.html
- title: Implementation
url: /android_implementation.html
- title: Documentation
url: /android_documentation.html
- title: iOS Guidelines
folderitems:
- title: Design
Expand Down
2 changes: 1 addition & 1 deletion _data/topnav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ topnav_dropdowns:
- title: General
url: /general_introduction.html
- title: Android (Draft)
url: /android_introduction.html
url: /android_design.html
- title: C (Draft)
url: /clang_design.html
- title: C++ (Draft)
Expand Down
2 changes: 1 addition & 1 deletion _includes/refs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[rest-lro]: https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#13-long-running-operations

[general-guidelines]: {{ site.baseurl }}{% link docs/general/introduction.md %}
[android-guidelines]: {{ site.baseurl }}{% link docs/android/introduction.md %}
[android-guidelines]: {{ site.baseurl }}{% link docs/android/design.md %}
[clang-guidelines]: {{ site.baseurl }}{% link docs/clang/design.md %}
[cpp-guidelines]: {{ site.baseurl }}{% link docs/cpp/introduction.md %}
[dotnet-guidelines]: {{ site.baseurl }}{% link docs/dotnet/introduction.md %}
Expand Down
655 changes: 452 additions & 203 deletions docs/android/design.md

Large diffs are not rendered by default.

83 changes: 0 additions & 83 deletions docs/android/documentation.md

This file was deleted.

Loading

0 comments on commit a091066

Please sign in to comment.