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

Publish docs to npm #5602

Merged
merged 2 commits into from
Aug 28, 2018
Merged

Publish docs to npm #5602

merged 2 commits into from
Aug 28, 2018

Conversation

sivakumar-kailasam
Copy link
Member

@sivakumar-kailasam sivakumar-kailasam commented Aug 28, 2018

This is required to be on par with ember-source so that api docs can rely on using npm for fetching the yuidocs for >= 3.4.0 releases.

@sivakumar-kailasam
Copy link
Member Author

@rwjblue @runspired looks like 3.4.0 docs didn't get published to s3. Can we merge this & get a patch version?

.npmignore Outdated
/node-tests
/tests
/tmp
/bin
/docs
Copy link
Contributor

Choose a reason for hiding this comment

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

is this still required if docs are now in dist/ ?

@runspired
Copy link
Contributor

So for what it does, this seems ok; however, I'm a bit confused as to why we now publish our docs on npm in this way (and why the emberjs website requires it). Does the S3 publishing no longer accomplish what the learning team needs? If so we should remove the S3 publishing.

@sivakumar-kailasam
Copy link
Member Author

sivakumar-kailasam commented Aug 28, 2018

why we now publish our docs on npm in this way

  • robert mentioned during 3.3 release that we should use npm as the source for the docs instead of s3
  • we've had other issues too over time when we had to look around for folks with s3 access & it seemed like publishing patch releases with any doc fixes was a better way to go about it

why the emberjs website requires it

This is for building the API docs' search index.

If so we should remove the S3 publishing.

I've modified the PR to remove the scripts for publishing yuidoc to s3 & to publish to npm instead

@runspired runspired merged commit 98215ed into emberjs:master Aug 28, 2018
@sivakumar-kailasam sivakumar-kailasam deleted the patch-1 branch August 29, 2018 09:00
NullVoxPopuli pushed a commit to NullVoxPopuli/data that referenced this pull request Sep 8, 2018
* Publish yuidoc json file to npm

* Remove the build step that publishes docs to s3
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