Skip to content

Proof of Concept documents #1

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

Merged
merged 5 commits into from
May 20, 2015
Merged

Proof of Concept documents #1

merged 5 commits into from
May 20, 2015

Conversation

blackdwarf
Copy link

This is the batch of documents for testing out ReadTheDocs (RTD) infrastructure.

It is a bit of a hefty PR, so a list of things that are in there:

  • The stubbed out Table of Contents
  • Each of the document linked in the TOC in its place (folder)
  • Stub notices for unfinished pages
  • DNX documents from the ASP.NET documentation
  • .NET Primer and CLR overview from the CoreCLR repo (converted to reST)
  • Config file for RTD

/cc @richlander

blackdwarf added 5 commits May 19, 2015 13:20
Adding initial, stubbed-out TOC for the ReadTheDocs (RTD) documents.
Also adding initial directory structure.
The current versions of "Intro To CLR" from the BOTR and .NET Primer
from the CoreCLR GuitHub repo, converted into restructuredText and
added to the TOC for RTD.
@richlander
Copy link
Member

LGTM

blackdwarf pushed a commit that referenced this pull request May 20, 2015
Proof of Concept documents
@blackdwarf blackdwarf merged commit 2fc2df0 into dotnet:master May 20, 2015
@blackdwarf blackdwarf deleted the PoC branch May 20, 2015 21:46
BethMassi pushed a commit that referenced this pull request Nov 5, 2015
@BethMassi BethMassi mentioned this pull request Nov 10, 2015
@blackdwarf blackdwarf mentioned this pull request Sep 6, 2016
guardrex added a commit that referenced this pull request May 1, 2017
* Initial commit

* Updates

* Updates

* Updates

* Revert removal of last official release spec

* Breaking changes work #1

* Fix merge conflict

* Updates

* React to feedback

* React to feedback

* Revert Docker for Windows removal

* Add note to install .NET Core workload with VS
rpetrusha pushed a commit that referenced this pull request May 8, 2017
mairaw added a commit that referenced this pull request May 27, 2017
dend pushed a commit that referenced this pull request Jun 5, 2017
rpetrusha pushed a commit that referenced this pull request Aug 16, 2017
Code does not show difference in using "lock"
mairaw pushed a commit that referenced this pull request Jun 4, 2018
* Fix-xref-commented-out-1

* Removed using-the-invokemethod-activity, added entry in openpublishing.redirection.json, modified System.ServiceModel.ServiceEndpoint

* Json spaces
mairaw added a commit that referenced this pull request Aug 11, 2018
* markdig changes

* change link

* fix code formatting

* feedback #1

* feedback #2

* fix c# code formatting

* more code formatting fixes
rpetrusha pushed a commit that referenced this pull request Oct 8, 2018
Formatting code snippets
rpetrusha pushed a commit that referenced this pull request Dec 4, 2018
* Began 2.2 revisions

* Updated

* Update dotnet-core-2-1.md

* Update dotnet-core-2-2.md

* Update index.md

* Revised and fixed broken anchors

* Addressed review comments

* Addressed feedback

* Added info about FDE (#1)

* Added info about FDE

* Update dotnet-core-2-2.md

* Updated for FDEs

* Corrected typoi
@GustavBrock GustavBrock mentioned this pull request Mar 2, 2019
luisquintanilla added a commit that referenced this pull request Apr 29, 2019
nishanil added a commit that referenced this pull request Jun 14, 2019
nishanil pushed a commit that referenced this pull request Aug 27, 2019
Bringing for up to date
mairaw added a commit that referenced this pull request Jan 28, 2020
* 10-22 Ch 5 PR

* 10-22 Ch 5 PR - fix images

* 10-22 Ch5 PR Update #1

* 10-23 Ch 5 fine-tuning verbage

* Update docs/architecture/cloud-native/distributed-data.md

Excellent. Thanks!

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* 10-27 Ch 5 Empty commit

* 10-29 Ch 5 Updated intro

* 11-01 Ch5 Cleansing Section 2

* 11-1 CH5 Updated Date

* 11-02 Ch 5 Section 2 updates

* 11-3 Ch 5 Section 2 fine tuning

* 11-3 Ch 5 Section 2 more fine tuning

* 11-3 ch 5 updates to section 3

* 11-4 Chatper 5 Section 3

* 11-06 Chapter 5 final update-pass 1

* 11-28 Ch 5 consolidated images in section 1

* 11-28 Ch 5 Updated Section 1

* 11-28 Ch 5 Updated Section 1 - fix md error

* 11-28 Ch 5 Consolidating Section 1 and 2

* 11-29 Ch 5 setion 1

* 12/5 Ch 5 Section 1

* 12-6 Ch 5 Event sourcing

* 12/8 ch 5 event sourcing

* 12/8 Chapter 5 Event Sourcing Section 1 complete

* 12/8 Ch 5 added caching and updated TOC

* 12/8 Ch 5 fix md fomratting error

* 12/8 Ch 5 fix 2nd md fomratting error

* 12/8 Ch 5 fix 3rd md fomratting error

* 12/18 Caching section complete

* 12/18 Caching section complete 2

* 12/19 Ch 5 updates to sql vs nosql

* 12/19 Ch 5 updates to sql vs nosql2

* 12/19 Ch 5 updates to sql vs nosql3

* 12/19 Ch 5 updates to sql vs nosql4

* 12/20 Ch 5 update to caching

* 12/20 Ch 5

* 12/21 Ch 5 WIP NoSQL vs SQL

* 12/21 Ch 5 WIP NoSQL vs SQL2

* 12/21 Ch 5 WIP SQL vs NoSQL

* 12/22 Ch 5

* 12/23 Ch 5 All except customer stories and ElaticSearch

* 12-24 Ch 5 Fine tuning to Sql vs NoSql

* 12/24 chapter 5 fine tuning to sql vs nosql

* 12/25 Ch 5 more fine tuning to sql vs nosql

* 12/25 Updates to navigation

* 12/25 Ch 5 added consistency graphic

* 12/25 Ch 5 corrections

* 12/27 Enhancing CosmosDB and NewSQL sections

* 12/27 Enhancing CosmosDB and NewSQL sections

* 12/29 Ch5 adding elasticsearch

* 12/29 Ch 5 lowercasing file name for Database-per-microservice

* 12/29 Ch 5 elastic complete first pass

* 12/30 CH 5 updates to Cosmos Table API

* 12/30 Ch 5 fine-tuning verbage

* 12/31 Ch 5 final wrap#1

* 12/31 Ch 5 final wrap#1 - fix link

* Update docs/architecture/cloud-native/Database-per-microservice.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/Database-per-microservice.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/Database-per-microservice.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/Database-per-microservice.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/azure-caching.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/azure-caching.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/Database-per-microservice.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/Database-per-microservice.md

Co-Authored-By: Nish Anil <nish@microsoft.com>

* Update docs/architecture/cloud-native/Database-per-microservice.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/azure-caching.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/azure-caching.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/elastic-search-in-azure.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/elastic-search-in-azure.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/relational-vs-nosql-data.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/relational-vs-nosql-data.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/relational-vs-nosql-data.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/relational-vs-nosql-data.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/relational-vs-nosql-data.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/relational-vs-nosql-data.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/Database-per-microservice.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Updates responding to PR comments from Nish and Maira

* Ch5 Push with PR Corrections

* Ch 5 fix warnings

* Ch 5 fix more warnings

* Ch 5 fix even more warnings

* Apply suggestions from code review

Commit updates

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>
Co-Authored-By: Nish Anil <nish@microsoft.com>

* rename

* rename #2

* Apply suggestions from code review

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update to TOC

* Apply suggestions from code review

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/relational-vs-nosql-data.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/relational-vs-nosql-data.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/relational-vs-nosql-data.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/relational-vs-nosql-data.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/relational-vs-nosql-data.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Update docs/architecture/cloud-native/relational-vs-nosql-data.md

Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>

* Removed NewSQL Database image

* set up redirects

* fix redirect

Co-authored-by: Maira Wenzel <mairaw@microsoft.com>
Co-authored-by: Nish Anil <nish@microsoft.com>
noahfalk referenced this pull request in noahfalk/docs Mar 15, 2021
We are about to announce support for OpenTelemetry .NET and there is
likely to be an influx of developers reading these docs. They are
already the #1 link for "distributed tracing" on bing.com so they are
probably getting above average traffic/scrutiny too.

- Reorganized the content into a landing page, conceptual docs,
instrumentation walkthroughs and collection walkthroughs
- Added some more intro and conceptual information assuming that many
developers are completely new to distributed tracing and have no
frame of reference.
- Removed the example of doing distributed tracing with DiagnosticSource
We might want to restore this in the future but hopefully it represents
a niche usage scenario that we are migrating away from. Without context
indicating when to use it it is likely to confuse new developers about
recommended patterns.
- Updated the examples to ensure they start with copy-pastable code
that is fully runnable.
- Added links for collecting distributed tracing instrumentation with
Application Insights

There are many oportunities for further improvement that we may
want to triage:
- Add examples and pictures of more realistic collected distributed
trace information to help developers internalize why it might be useful
to them.
- Add a diagnostic guide showing how distributed tracing assists in
resolving a realistic production issue.
- Ensure the getting started guides for collection transfer smoothly to
remote pages in the AppInsights and OpenTelemetry docs
  - There was a spot I wanted to link to supported OpenTelemetry
     exporters but there is no anchor that goes solely to that
     information.
- Flesh out the instrumentation guidance to answer more questions
developers may encounter such as:
  - naming conventions for Activity
  - when to use DisplayName
  - how to log exceptions
  - how to use links for batch processing systems
  - how to propagate IDs to and from network protocols
  - how to migrate pre-existing Activity instrumentation to use
     ActivitySource
- Add performance analysis and guidance to reassure developers that
  Activity instrumentation + OpenTelemetry are serious about high
  performance workloads.
- Discuss more conceptual topics and/or go into greater depth about
some areas:
  - Hierarchical vs. W3C ID.
  - Format of a W3C ID
  - Describe sampling options in ActivityListener
  - Explain why some activities are uncapturable with ActivityListener
     and require workarounds with DiagnosticListener.
 - Roadmap for handling issues around custom propagators, supporting
protocol updates, and suppressing undesired automatic Activity creation
noahfalk referenced this pull request in noahfalk/docs Mar 15, 2021
We are about to announce support for OpenTelemetry .NET and there is
likely to be an influx of developers reading these docs. They are
already the #1 link for "distributed tracing" on bing.com so they are
probably getting above average traffic/scrutiny too.

- Reorganized the content into a landing page, conceptual docs,
instrumentation walkthroughs and collection walkthroughs
- Added some more intro and conceptual information assuming that many
developers are completely new to distributed tracing and have no
frame of reference.
- Removed the example of doing distributed tracing with DiagnosticSource
We might want to restore this in the future but hopefully it represents
a niche usage scenario that we are migrating away from. Without context
indicating when to use it it is likely to confuse new developers about
recommended patterns.
- Updated the examples to ensure they start with copy-pastable code
that is fully runnable.
- Added links for collecting distributed tracing instrumentation with
Application Insights

There are many oportunities for further improvement that we may
want to triage:
- Add examples and pictures of more realistic collected distributed
trace information to help developers internalize why it might be useful
to them.
- Add a diagnostic guide showing how distributed tracing assists in
resolving a realistic production issue.
- Ensure the getting started guides for collection transfer smoothly to
remote pages in the AppInsights and OpenTelemetry docs
  - There was a spot I wanted to link to supported OpenTelemetry
     exporters but there is no anchor that goes solely to that
     information.
- Flesh out the instrumentation guidance to answer more questions
developers may encounter such as:
  - naming conventions for Activity
  - when to use DisplayName
  - how to log exceptions
  - how to use links for batch processing systems
  - how to propagate IDs to and from network protocols
  - how to migrate pre-existing Activity instrumentation to use
     ActivitySource
- Add performance analysis and guidance to reassure developers that
  Activity instrumentation + OpenTelemetry are serious about high
  performance workloads.
- Discuss more conceptual topics and/or go into greater depth about
some areas:
  - Hierarchical vs. W3C ID.
  - Format of a W3C ID
  - Describe sampling options in ActivityListener
  - Explain why some activities are uncapturable with ActivityListener
     and require workarounds with DiagnosticListener.
 - Roadmap for handling issues around custom propagators, supporting
protocol updates, and suppressing undesired automatic Activity creation
noahfalk referenced this pull request in noahfalk/docs Mar 15, 2021
We are about to announce support for OpenTelemetry .NET and there is
likely to be an influx of developers reading these docs. They are
already the #1 link for "distributed tracing" on bing.com so they are
probably getting above average traffic/scrutiny too.

- Reorganized the content into a landing page, conceptual docs,
instrumentation walkthroughs and collection walkthroughs
- Added some more intro and conceptual information assuming that many
developers are completely new to distributed tracing and have no
frame of reference.
- Removed the example of doing distributed tracing with DiagnosticSource
We might want to restore this in the future but hopefully it represents
a niche usage scenario that we are migrating away from. Without context
indicating when to use it it is likely to confuse new developers about
recommended patterns.
- Updated the examples to ensure they start with copy-pastable code
that is fully runnable.
- Added links for collecting distributed tracing instrumentation with
Application Insights

There are many oportunities for further improvement that we may
want to triage:
- Add examples and pictures of more realistic collected distributed
trace information to help developers internalize why it might be useful
to them.
- Add a diagnostic guide showing how distributed tracing assists in
resolving a realistic production issue.
- Ensure the getting started guides for collection transfer smoothly to
remote pages in the AppInsights and OpenTelemetry docs
  - There was a spot I wanted to link to supported OpenTelemetry
     exporters but there is no anchor that goes solely to that
     information.
- Flesh out the instrumentation guidance to answer more questions
developers may encounter such as:
  - naming conventions for Activity
  - when to use DisplayName
  - how to log exceptions
  - how to use links for batch processing systems
  - how to propagate IDs to and from network protocols
  - how to migrate pre-existing Activity instrumentation to use
     ActivitySource
- Add performance analysis and guidance to reassure developers that
  Activity instrumentation + OpenTelemetry are serious about high
  performance workloads.
- Discuss more conceptual topics and/or go into greater depth about
some areas:
  - Hierarchical vs. W3C ID.
  - Format of a W3C ID
  - Describe sampling options in ActivityListener
  - Explain why some activities are uncapturable with ActivityListener
     and require workarounds with DiagnosticListener.
 - Roadmap for handling issues around custom propagators, supporting
protocol updates, and suppressing undesired automatic Activity creation
noahfalk referenced this pull request in noahfalk/docs Mar 15, 2021
We are about to announce support for OpenTelemetry .NET and there is
likely to be an influx of developers reading these docs. They are
already the #1 link for "distributed tracing" on bing.com so they are
probably getting above average traffic/scrutiny too.

- Reorganized the content into a landing page, conceptual docs,
instrumentation walkthroughs and collection walkthroughs
- Added some more intro and conceptual information assuming that many
developers are completely new to distributed tracing and have no
frame of reference.
- Removed the example of doing distributed tracing with DiagnosticSource
We might want to restore this in the future but hopefully it represents
a niche usage scenario that we are migrating away from. Without context
indicating when to use it it is likely to confuse new developers about
recommended patterns.
- Updated the examples to ensure they start with copy-pastable code
that is fully runnable.
- Added links for collecting distributed tracing instrumentation with
Application Insights

There are many oportunities for further improvement that we may
want to triage:
- Add examples and pictures of more realistic collected distributed
trace information to help developers internalize why it might be useful
to them.
- Add a diagnostic guide showing how distributed tracing assists in
resolving a realistic production issue.
- Ensure the getting started guides for collection transfer smoothly to
remote pages in the AppInsights and OpenTelemetry docs
  - There was a spot I wanted to link to supported OpenTelemetry
     exporters but there is no anchor that goes solely to that
     information.
- Flesh out the instrumentation guidance to answer more questions
developers may encounter such as:
  - naming conventions for Activity
  - when to use DisplayName
  - how to log exceptions
  - how to use links for batch processing systems
  - how to propagate IDs to and from network protocols
  - how to migrate pre-existing Activity instrumentation to use
     ActivitySource
- Add performance analysis and guidance to reassure developers that
  Activity instrumentation + OpenTelemetry are serious about high
  performance workloads.
- Discuss more conceptual topics and/or go into greater depth about
some areas:
  - Hierarchical vs. W3C ID.
  - Format of a W3C ID
  - Describe sampling options in ActivityListener
  - Explain why some activities are uncapturable with ActivityListener
     and require workarounds with DiagnosticListener.
 - Roadmap for handling issues around custom propagators, supporting
protocol updates, and suppressing undesired automatic Activity creation
noahfalk added a commit that referenced this pull request Mar 24, 2021
* Update distributed tracing docs

We are about to announce support for OpenTelemetry .NET and there is
likely to be an influx of developers reading these docs. They are
already the #1 link for "distributed tracing" on bing.com so they are
probably getting above average traffic/scrutiny too.

- Reorganized the content into a landing page, conceptual docs,
instrumentation walkthroughs and collection walkthroughs
- Added some more intro and conceptual information assuming that many
developers are completely new to distributed tracing and have no
frame of reference.
- Removed the example of doing distributed tracing with DiagnosticSource
We might want to restore this in the future but hopefully it represents
a niche usage scenario that we are migrating away from. Without context
indicating when to use it it is likely to confuse new developers about
recommended patterns.
- Updated the examples to ensure they start with copy-pastable code
that is fully runnable.
- Added links for collecting distributed tracing instrumentation with
Application Insights

There are many oportunities for further improvement that we may
want to triage:
- Add examples and pictures of more realistic collected distributed
trace information to help developers internalize why it might be useful
to them.
- Add a diagnostic guide showing how distributed tracing assists in
resolving a realistic production issue.
- Ensure the getting started guides for collection transfer smoothly to
remote pages in the AppInsights and OpenTelemetry docs
  - There was a spot I wanted to link to supported OpenTelemetry
     exporters but there is no anchor that goes solely to that
     information.
- Flesh out the instrumentation guidance to answer more questions
developers may encounter such as:
  - naming conventions for Activity
  - when to use DisplayName
  - how to log exceptions
  - how to propagate IDs to and from network protocols
  - how to migrate pre-existing Activity instrumentation to use
     ActivitySource
- Add performance analysis and guidance to reassure developers that
  Activity instrumentation + OpenTelemetry are serious about high
  performance workloads.
- Discuss more conceptual topics and/or go into greater depth about
some areas:
  - Hierarchical vs. W3C ID.
  - Format of a W3C ID
  - Describe sampling options in ActivityListener
  - Explain why some activities are uncapturable with ActivityListener
     and require workarounds with DiagnosticListener.
 - Roadmap for handling issues around custom propagators, supporting
protocol updates, and suppressing undesired automatic Activity creation
@oluwafemi-coder oluwafemi-coder mentioned this pull request Jun 7, 2021
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