Add platform to glossary #30731
Add platform to glossary #30731
Conversation
jbogarthyde
added
comp: docs
effort1: hours
target: patch
|
You can preview b936e4e at https://pr30731-b936e4e.ngbuilds.io/. |
|
You can preview b9be57d at https://pr30731-b9be57d.ngbuilds.io/. |
|
You can preview 242c7b2 at https://pr30731-242c7b2.ngbuilds.io/. |
|
You can preview 75b7911 at https://pr30731-75b7911.ngbuilds.io/. |
|
You can preview 8a85db1 at https://pr30731-8a85db1.ngbuilds.io/. |
aio/content/guide/glossary.md
Outdated
| Support for the various Angular run-time platforms is provided by the `@angular/platform-*` packages. | ||
| A platform can [polyfill](#polyfill) certain APIs or provide new platform-specific APIs. | ||
|
|
||
| * When running in a web browser, the [`platform-browser`](api/platform-browser) package supplies services that allow applications to access browser-specific features, such as the title of the document being displayed. All applications running in the browser use the same platform service. |
There was a problem hiding this comment.
platform- packages primarily enable apps written against @angular/core, @angualar/common and friends to execute in different environments by providing implementation for gathering user input and rendering UIs for the given platform. This allows Angular apps to be written In a platform independent way. The title service is one example of that but that API is quite insignificant compared to general dom manipulation apis that platforms abstract away.
There was a problem hiding this comment.
@IgorMinar Please check rewrite
|
You can preview 0e13f48 at https://pr30731-0e13f48.ngbuilds.io/. |
|
You can preview a1affd6 at https://pr30731-a1affd6.ngbuilds.io/. |
jbogarthyde
force-pushed
the
jb-platform
branch
2 times, most recently
from
ec1392b
to
b74ef59
Compare
|
You can preview ec1392b at https://pr30731-ec1392b.ngbuilds.io/. |
|
You can preview b74ef59 at https://pr30731-b74ef59.ngbuilds.io/. |
| @@ -622,6 +622,19 @@ A class which is preceded by the `@Pipe{}` decorator and which defines a functio | |||
|
|
|||
| To learn more, see [Pipes](guide/pipes). | |||
|
|
|||
| {@a platform} | |||
|
|
|||
| ## platform | |||
There was a problem hiding this comment.
The entire section doesn't mention about platform APIs like PlatformRef and createPlatformFactory, but only the platform package.
But without mentioning platform APIs I'll ask what's the real difference between a platform package and non-platform package? If it's just about environment setup, will something like ng-jest being recognized a platform package?
There was a problem hiding this comment.
This is not platform doc, just a glossary definition that is supposed to clarify how we use the term "platform" in the context of Angular development. We probably do need better API and usage doc - we could open an issue for that.
@IgorMinar what do you think?
There was a problem hiding this comment.
Initially I thought that this wasn't the place for those APIs mentioned by @trotyl, but after looking at the SSR guide and the platform-server/browser page (where they aren't mentioned) and reviewing how central they are to the platform packages, this might actually be a good place to link to and mention them briefly.
There was a problem hiding this comment.
Not much point in linking to them if they aren't discussed there. This should be mentioned in the issue, to make sure the link gets in when those docs are updated.
There was a problem hiding this comment.
According to current concept, are platform-browser and platform-browser-dynamic same platform or not?
|
You can preview d2e5bbe at https://pr30731-d2e5bbe.ngbuilds.io/. |
|
You can preview ee2a7dc at https://pr30731-ee2a7dc.ngbuilds.io/. |
|
You can preview 20eabfe at https://pr30731-20eabfe.ngbuilds.io/. |
jbogarthyde
force-pushed
the
jb-platform
branch
2 times, most recently
from
bed5923
to
320d988
Compare
|
You can preview bed5923 at https://pr30731-bed5923.ngbuilds.io/. |
|
You can preview 320d988 at https://pr30731-320d988.ngbuilds.io/. |
|
You can preview 64072bf at https://pr30731-64072bf.ngbuilds.io/. |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
"Platform" term not in glossary
Issue Number: #27096
What is the new behavior?
Adds "platform" term with ref to API doc and Browser Support page.
Does this PR introduce a breaking change?
Other information
API doc for PlatformRef/PlatformBrowser is not adequate, and there is no usage doc except a detached cookbook page, https://angular.io/guide/set-document-title