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

[docs] updates docs to use ember-cli-addon-docs #79

Merged
merged 3 commits into from
Mar 29, 2020

Conversation

gabrielcsapo
Copy link
Contributor

@gabrielcsapo gabrielcsapo commented Mar 27, 2020

Looking at the open issues I wanted to add additional docs, but those should probably be done after we merge this, as this is a large change as it is.

What does this look like?

Screen Shot 2020-03-26 at 8 14 51 PM

Screen Shot 2020-03-26 at 8 14 49 PM

How do I test this locally

Pulling down this branch and running ember s will allow you to navigate to http://localhost:4200

fixes #78

@gabrielcsapo
Copy link
Contributor Author

Thoughts on this? @efx @dgeb @villander

@villander villander requested review from villander and dgeb March 27, 2020 18:22
@villander
Copy link
Member

Thanks for pushing this @gabrielcsapo, an amazing job!
I'll review it this weekend.

Looking at the open issues I wanted to add additional docs, but those should probably be done after we merge this, as this is a large change as it is.

What additional docs, do you like to add? Is there something align with #55 ?

@gabrielcsapo
Copy link
Contributor Author

Yeah I think adding additional docs and potentially cleaning up the doc hierarchy can be done after this is merged.

@villander
Copy link
Member

villander commented Mar 27, 2020

Awesome, thanks for it. I'll review it as soon as possible to unblock you ; )

If you have some time, let's talk on Discord ; )

package.json Outdated Show resolved Hide resolved
"ember-cli-addon-docs": "^0.6.16",
"ember-cli-addon-docs-esdoc": "^0.2.3",
"ember-cli-dependency-checker": "^3.2.0",
"ember-cli-deploy": "^1.0.2",
Copy link
Member

Choose a reason for hiding this comment

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

how can we manage to deploy here? As I know this codebase already deploys on master when CI is green.

If we going to change it, maybe we need rethink our infrastructure on Heroku

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This will currently deploy to gh-pages branch, do we deploy from that?

Copy link
Member

@villander villander Mar 27, 2020

Choose a reason for hiding this comment

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

Currently, we are doing deploy automatically to Heroku. I prefer GitHub pages, but we need to change it and make sure that it will work fine without some unavailability. And make sure that GitHub pages will have the current site URL/domain.

cc: @dgeb

package.json Outdated Show resolved Hide resolved
Copy link
Member

@villander villander left a comment

Choose a reason for hiding this comment

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

Thank you!

I've some notes.

@villander
Copy link
Member

Waiting for @dgeb support to change deployment to Github pages using the same domain.

@gabrielcsapo
Copy link
Contributor Author

@villander looking into this, this will not only support deployment to GitHub Pages but also heroku. Heroku seems to just be running ember serve based on the revert of the prember code.

@gabrielcsapo
Copy link
Contributor Author

it seems like I commented on an issue about moving to GitHub last year #42 (comment) 🤦‍♂

@villander villander merged commit f9606a4 into ember-engines:master Mar 29, 2020
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.

Use ember-cli-addon-docs for built site
2 participants