Skip to content

Platform is not described in documentation glossary #27096

Closed

Description

@BrunnerLivio

📚 Docs or angular.io bug report

Description

Lurking through the angular source code I've found createPlatform. Unfortunately I have not found out through the docs or comments of Angular what a platform actually represents. I think the glossary would be the best place for a description?

🔬 Minimal Reproduction

What's the affected URL?**

https://angular.io/guide/glossary

Activity

  1. added this to the needsTriage milestone on Nov 14, 2018
  2. modified the milestones: needsTriage, Backlog on Nov 20, 2018
  3. jenniferfell commented on Nov 20, 2018

    @jenniferfell
    Contributor

    Starter definition: https://en.wikipedia.org/wiki/Computing_platform
    "he environment in which a piece of software is executed. It may be the hardware or the operating system (OS), even a web browser and associated application programming interfaces, or other underlying software, as long as the program code is executed with it. "

    In the context of Angular, "platform" can mean all of Angular or more specifically the context in which the Angular app runs. We could be more clear about what "runs" means in that loose definition.

    In addition to a glossary addition, the following APIs docs should be clear about how "platform" is used in this context

    • common/isPlatform*
    • platform-browser package
    • platform-server package
    • platform-webworker package
  4. BrunnerLivio commented on Nov 21, 2018

    @BrunnerLivio
    Author

    I see.. What kind of confused me was the platform platformCore, which is not tied to any "platform" which an Angular app runs on. But after some digging I realized platforms kind of inherit themselves platformCore <- platformCoreDynamic <- platformBrowserDynamic and each platform comes with its own providers.

    Am I getting this right?
    If so I think it would be quite interesting to see in the docs platform X is based on platform Y and which providers come with it.

  5. gkalpak commented on Nov 21, 2018

    @gkalpak
    Member

    Basically, the main docs for Angular's PlatformRef is here, but I agree that the docs for the specific platformRefs created by the various factories (e.g. platformBrowser(), platformBrowserDynamic(), etc) are pretty thin on details 😳

  6. Splaktar commented on May 22, 2019

    @Splaktar
    Contributor

    We needed these docs today while trying to explain the @angular/webworker deprecation in #30598.

  7. kapunahelewong commented on May 22, 2019

    @kapunahelewong
    Contributor
  8. angular-automatic-lock-bot commented on Sep 15, 2019

    @angular-automatic-lock-bot

    This issue has been automatically locked due to inactivity.
    Please file a new issue if you are encountering a similar or related problem.

    Read more about our automatic conversation locking policy.

    This action has been performed automatically by a bot.

  9. locked and limited conversation to collaborators on Sep 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions