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

Get Started: Updates #662

Merged
merged 15 commits into from
Feb 19, 2024
Merged

Get Started: Updates #662

merged 15 commits into from
Feb 19, 2024

Conversation

renejeglinsky
Copy link
Contributor

@renejeglinsky renejeglinsky commented Jan 30, 2024

Went through the guide and made some updates

@swaldmann
Copy link
Contributor

swaldmann commented Jan 30, 2024

Fully agree with replacing the TIP heading with the first sentence as you did. However, the query options sample is important enough to the flow of the guide to remain top-level imo. I fear if included in the tip box many users will skip this part.

@smahati
Copy link
Contributor

smahati commented Jan 30, 2024

The tip is relevant to the other part, so maybe we could move the information out of the tip and into the main text.

@danjoa
Copy link
Contributor

danjoa commented Jan 30, 2024

Switch from TIP to INFO makes it nicer IMO:

No. this needs to stay a positive eye catcher → hence tip

@swaldmann
Copy link
Contributor

swaldmann commented Jan 31, 2024

As the orange in the link + the green in the tip have semantic and not just ornamental value I think the coloring here is fine, even if a bit colorful.

Imo the tip is most helpful before the sentence explaining $select etc. for setting base expectations.

@renejeglinsky
Copy link
Contributor Author

If the sentence explaining $select is a continuation of the note, it should be in the note.
Anyway, will make changes and merge. At least paths and stuff are fixed.


CAP-based services are full-fledged OData services out of the box. Without adding any provider implementation code, they translate OData request into corresponding database requests, and return the results as OData responses.
http://localhost:4004/odata/v4/browse/Books?$search=Brontë&$select=title,author&$expand=currency($select=code,name,symbol)&$orderby=title
Copy link
Contributor Author

Choose a reason for hiding this comment

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

At this point of the guide, we don't have any data yet. So this link doesn't show anything. Does it add value anyhow? Or should we move this section a bit?

@renejeglinsky renejeglinsky changed the title Get Started: Reduce visual noise Get Started: Updates Jan 31, 2024
Comment on lines +774 to +775
if (context.getQuantity() > book.getStock())
throw new IllegalArgumentException(context.getQuantity() + " exceeds stock for book #" + book.getTitle());
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rjayasinghe Is that fine for you?

@renejeglinsky renejeglinsky merged commit bd73921 into main Feb 19, 2024
4 checks passed
@renejeglinsky renejeglinsky deleted the get-started-odata branch February 19, 2024 10:59
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.

6 participants