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

chore: update documentation site #1536

Merged
merged 9 commits into from Mar 19, 2019
Merged

Conversation

awentzel
Copy link
Collaborator

@awentzel awentzel commented Mar 13, 2019

Description

  1. Update status page to reflect changes made to pipelines recently
  2. Update TypeDoc naming to be case sensitive when used in documentation
  3. Rebuild API documentation

Motivation & context

Keeping up with latest DevOps and code changes
closed #1509 #1536 #1394 #1497

Issue type checklist

  • Chore: A change that does not impact distributed packages.
  • Bug fix: A change that fixes an issue, link to the issue above.
  • New feature: A change that adds functionality.

Is this a breaking change?

  • This change causes current functionality to break.

Process & policy checklist

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

@awentzel awentzel self-assigned this Mar 13, 2019
Copy link
Member

@chrisdholt chrisdholt left a comment

Choose a reason for hiding this comment

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

I don't think we want to include all these generated files.

@janechu
Copy link
Collaborator

janechu commented Mar 13, 2019

I would add to @chrisdholt comment that this should be automated as well, we don't want to have to create PRs for generated files that should be added when we update any README.

@awentzel
Copy link
Collaborator Author

I've addressed all concerns @janechu @chrisdholt please review

@awentzel awentzel force-pushed the users/awentzel/docs-status-update branch from 4abaf20 to ca079de Compare March 19, 2019 16:59
@awentzel awentzel requested a review from janechu March 19, 2019 17:05
@codeclimate
Copy link

codeclimate bot commented Mar 19, 2019

Code Climate has analyzed commit 25ddd44 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 88.2% (0.0% change).

View more on Code Climate.

@awentzel awentzel merged commit 8c64c4c into master Mar 19, 2019
@awentzel awentzel deleted the users/awentzel/docs-status-update branch March 19, 2019 17:24
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.

None yet

5 participants