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

Add AEPMedia Documentation #40

Merged
merged 9 commits into from
May 20, 2021
Merged

Add AEPMedia Documentation #40

merged 9 commits into from
May 20, 2021

Conversation

cacheung
Copy link
Contributor

Add AEPMedia Documentation
And add package.resolved to gitignore file.

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Add AEPMedia Documentation
Fix format issue
update .gitignore to ignore Package.resolved file
@cacheung cacheung requested review from addb and praveek May 17, 2021 19:56
update doc
@codecov
Copy link

codecov bot commented May 17, 2021

Codecov Report

Merging #40 (14ab242) into dev-v3.0.1 (8d72639) will not change coverage.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           dev-v3.0.1      #40   +/-   ##
===========================================
  Coverage       93.00%   93.00%           
===========================================
  Files              28       28           
  Lines            2101     2101           
===========================================
  Hits             1954     1954           
  Misses            147      147           

remove package.resolved
## createTracker
Creates a media tracker instance that tracks the playback session. The tracker created should be used to track the streaming content, and it sends periodic pings to the media analytics backend.

{% hint style="info" %}
Copy link
Contributor

Choose a reason for hiding this comment

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

Hint tags are not supported in markdown. Can we just use an emoji like (⚠️ ) to show it is an hint

Update table of content format
Documentation/AEPMedia.md Outdated Show resolved Hide resolved
Fix broken links
updated with doc review comments
few more format update
@praveek praveek changed the base branch from dev-v3.0.1 to main May 20, 2021 15:51
@cacheung cacheung merged commit 388734a into adobe:main May 20, 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