-
Notifications
You must be signed in to change notification settings - Fork 532
Fluid Terminology
Joshua Smithrud edited this page Jul 15, 2022
·
1 revision
Like any framework introducing new concepts / paradigms, the Fluid Framework has a set of native terminology that we use frequently.
To lower the barrier to entry, and generally make our documentation more accessible, it is important that we are consistent in the ways we refer to our concepts. This document outlines common dos and don'ts regarding our terminology.
-
"Fluid" and "Fluid Framework" are a proper nouns and should be capitalized, but these are not:
- "container"
- "service"
- "object"
- "driver"
- "runtime"
- "host"
-
"Fluid service", not "Fluid server"
- "Container code" - not "Container Code"
- "URL" - not "url" or "Url"
- "JavaScript" - not "Jypescript" or "javascript"
- "TypeScript" - not "Typescript" or "typescript"
- "Node.js" - not "node" or "nodejs", etc.
- "npm" (always lower-case)
This wiki is focused on contributing to the Fluid Framework codebase.
For information on using Fluid Framework or building applications on it, please refer to fluidframework.com.
- Submitting Bugs and Feature Requests
-
Contributing to the Repo
- Repo Basics
- Common Workflows and Patterns
- Managing dependencies
- Client Code
- Server Code
- PR Guidelines
- CI Pipelines
- Breaking vs Non-Breaking Changes
- Branches, Versions, and Releases
- Compatibility & Versioning
- Testing
- Debugging
- npm package scopes
- Maintaining API support levels
- Developer Tooling Maintenance
- API Deprecation
- Working with the Website (fluidframework.com)
- Coding Guidelines
- Documentation Guidelines
- CLA