facebook / relay

Relay is a JavaScript framework for building data-driven React applications.
https://relay.dev
MIT License
18.37k stars 1.82k forks source link

Docs: Link for `@defer` directive (and others) points to intern #3574

Open garyolsen opened 3 years ago

garyolsen commented 3 years ago

In the most recent Glossary page in the docs, the "See the documentation" link for @defer points to the wiki: https://www.internalfb.com/intern/wiki/Relay/Web/incremental-data-delivery-defer-stream/#defer

It'd be helpful to get some more information about how the directive works into the public docs.


There are other links to intern in the docs, though it looks like a few of them are intentional—it may be worth auditing this list to see if they should be changed. If not, I can open a PR updating the docs to at least indicate them as FB-only.

docs % grep -R '/intern/' .
./api-reference/hooks/use-query-loader.md:            * `fetchPolicy`: _*[Optional]*_ Determines if cached data should be used, and when to send a network request based on the cached data that is currently available in the Relay store (for more details, see our [Fetch Policies](https://www.internalfb.com/intern/wiki/Relay/guided-tour-of-relay/reusing-cached-data-for-rendering/#fetch-policies) and [Garbage Collection](https://www.internalfb.com/intern/wiki/Relay/guided-tour-of-relay/reusing-cached-data-for-rendering/#garbage-collection-in-re) guides):
./api-reference/entrypoint-apis/use-entrypoint-loader.md:For more information, see the [Loading EntryPoints](https://www.internalfb.com/intern/wiki/Relay/Guides/entry-points/#loading-entrypoints) guide.
./guided-tour/introduction.md:* [Javascript](https://our.internmc.facebook.com/intern/wiki/JavaScript/)
./guided-tour/introduction.md:* [React](https://our.internmc.facebook.com/intern/wiki/ReactGuide/)
./guided-tour/introduction.md:* [GraphQL](https://our.internmc.facebook.com/intern/wiki/GraphQL/) and our internal [GraphQL Server](https://our.internmc.facebook.com/intern/wiki/Graphql-for-hack-developers/)
./guided-tour/updating-data/graphql-mutations.md:* Check out the [Hack documentation on writing mutations](https://www.internalfb.com/intern/wiki/Graphql-for-hack-developers/mutation-root-fields/) for information on how to add a mutation field to your back-end code.
./guided-tour/updating-data/graphql-subscriptions.md:[GraphQL Subscriptions](https://our.internmc.facebook.com/intern/wiki/GraphQL_Subscriptions/) (GQLS) are a mechanism which allow clients to subscribe to changes in a piece of data from the server, and get notified whenever that data changes.
./guided-tour/updating-data/graphql-subscriptions.md:At Facebook, the Network Layer has already been configured to handle GraphQL Subscriptions. For more details on writing subscriptions at Facebook, check out this [guide](../../../guides/writing-subscriptions/). For a guide on setting up subscriptions on the server side, check out this [wiki](https://our.internmc.facebook.com/intern/wiki/GraphQL_Subscriptions/creating-a-new-subscription/).
./guides/testing-relay-with-preloaded-queries.md:* [D23078476](https://internalfb.com/intern/diff/D23078476)
./glossary/glossary.md:A field implementing the connection spec. See <a href="https://www.internalfb.com/intern/wiki/Graphql-connections-for-hack-developers/Connection-spec/">here</a> for more details on the spec, and the section of the guided tour on <a href="../guided-tour/list-data/pagination/">rendering list data and pagination</a>.
./glossary/glossary.md:See the [documentation](https://www.internalfb.com/intern/wiki/Relay/Web/incremental-data-delivery-defer-stream/#defer).
./glossary/glossary.md:See the [documentation](https://www.internalfb.com/intern/wiki/Relay/Debugging_Guides/Relay_DevTools_Guide_For_Users/).
./glossary/glossary.md:See more information in the [guided tour](https://www.internalfb.com/intern/wiki/Relay/guided-tour-of-relay/reusing-cached-data-for-rendering/#garbage-collection-in-re).
./glossary/glossary.md:See the [section in the guide](https://www.internalfb.com/intern/wiki/Relay/guided-tour-of-relay/updating-data/#invalidating-data-during).
./glossary/glossary.md:See the [guide on mutations](../guided-tour/updating-data/graphql-mutations), and [this article](https://www.internalfb.com/intern/wiki/Graphql-for-hack-developers/mutation-root-fields/) on defining mutations in your hack code.
./glossary/glossary.md:Projects are defined in a single [config](#config) file, found [here](https://www.internalfb.com/intern/diffusion/WWW/browse/master/scripts/relay/compiler-rs/config.www.json) and [here](https://www.internalfb.com/intern/diffusion/FBS/browse/master/xplat/relay/compiler-rs/config.xplat.json).
./glossary/glossary.md:For more info, look [here](https://www.internalfb.com/intern/wiki/GraphQL/Build_Infra/Schema_Sync/) and [here](https://www.internalfb.com/intern/wiki/Relay-team/GraphQL_Schema_Sync/).
stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

matthewoates commented 2 years ago

not stale, still an issue

Daniel15 commented 2 years ago

Some of them are intentional - The documentation has some internal-only content, usually wrapped in <FbInternalOnly>, that's only visible when Meta employees view our internal version of the docs.

Do any of these links still appear in the public-facing documentation?