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: remove calling other apis page #1177

Closed
wants to merge 1 commit into from
Closed

Conversation

virkt25
Copy link
Contributor

@virkt25 virkt25 commented Mar 22, 2018

connected to #988
Copy of loopbackio/loopback.io#641 since docs were migrated before that PR landed.

The entire page is a big To Do as the features haven't been implemented yet. I am proposing removing this page TILL these features are implemented at which point the docs have to be written anyways.

RATIONALE: There is no content worth keeping and as a user when I click the page I would expect to find information on how to accomplish what the title states instead of finding a page saying it's a feature to be added to the framework.

Checklist

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in packages/example-* were updated

@virkt25 virkt25 added this to the March 2018 milestone Mar 22, 2018
@virkt25 virkt25 self-assigned this Mar 22, 2018
@virkt25 virkt25 requested a review from a team March 22, 2018 23:44
Copy link
Contributor

@shimks shimks left a comment

Choose a reason for hiding this comment

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

Should we just remove the page from the sidebar and call it done? It'd be nicer to keep the page around as a reminder, but if an issue tracks what the page is supposed to remind us, then I'm happy with the changes.

@virkt25
Copy link
Contributor Author

virkt25 commented Mar 23, 2018

There's only 3 bullets on the page. I think that's the obvious sections someone will write as they work on the docs after this feature is implemented.

@raymondfeng
Copy link
Contributor

Maybe keeping the pages and adding a disclaimer to state such feature is to be implemented makes sense in this case for two reasons:

  1. The feature is coming soon
  2. We can avoid questions for those who already know LB3 can interact with REST/SOAP/... and wonder if LB4 does so or not

I won't block the PR if majority of us think it's better to remove.

@virkt25
Copy link
Contributor Author

virkt25 commented Mar 23, 2018

User can see features we have planned via WIP PR's and Issues. I don't think Docs is the place to show it but that said I'm not against keeping the page.

@raymondfeng Do you think the current notice on the page is sufficient?

Work-in-progress: This section is not yet complete.

@bajtos
Copy link
Member

bajtos commented Mar 27, 2018

I slightly prefer Raymond's proposal to keep the page with the current TODO notice, but don't mind to remove the page either.

@bajtos bajtos removed their request for review March 27, 2018 11:54
@virkt25
Copy link
Contributor Author

virkt25 commented Mar 27, 2018

Closing this PR as the page has a notice that this is a feature that is coming soon.

@virkt25 virkt25 closed this Mar 27, 2018
@virkt25 virkt25 deleted the docs/calling-apis branch March 27, 2018 14:45
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.

5 participants