Style guide: Difference between revisions
Jump to navigation
Jump to search
Line 92: | Line 92: | ||
| Views || Yes || No || Yes || | | Views || Yes || No || Yes || | ||
|- | |- | ||
| View Trace || ''' | | View Trace || Yes || Yes || Yes || Need one more image + '''What are placeholder paths?''' | ||
|- | |- | ||
| Integration Model Editor || '''No''' || No || No || | | Integration Model Editor || '''No''' || No || No || |
Revision as of 13:41, 13 October 2022
This is the Style Guide for developing documentation on this site for PHENOM Portal.
Graphics
When including a screenshot or graphic for an article:
- Reuse an existing graphic. You can search the existing graphics here.
- If the existing graphic is out of date, upload a new version of the graphic.
- If you are uploading a new graphic, specify a description using the following pattern: phenom-[area_of_phenom]-[brief-description-of-what-image-is-showing].[png|jpg]
- The upload will require a Description so please include a reasonable explanation.
- For Thumbnail, choose 'none'
- For Frame, choose 'frame' or select 'none' and add 'border' to the the file block [[File:xxx|border]] to have a small border around the image
- If the screenshot is too big, resize it by providing the width in px: [[File:xxx|600px]]
Confluence pages status
Page | Added to Wiki | Needs more work | Updated to new UI | Comments |
---|---|---|---|---|
FAQ | No | No | No | |
Data Model Governance | No | No | No | |
About Proprietary Data | No | No | No | |
Considerations for Data Model Governance | No | No | No | |
Data Sharing, Protection & Partitioning | No | No | No | |
Getting Started | Yes | No | N/A | |
How-To Articles | Yes | No | Yes | |
Login | Yes | No | N/A | |
Dashboard | Yes | Yes | No | |
Release Notes | No | No | No | |
Search Bar | Yes | Yes | No | |
Settings | Yes | Yes | Yes | |
Account | Partially | No | No | |
Subscription | No | No | No | |
Navigate | Yes | No | Yes | Renamed to Data Modeling |
Nav Tree | Partially | No | Yes | |
Moving Elements | No | No | No | |
Searching & Filtering | No | No | No | |
Tagging | No | No | No | |
Meridian Map | Yes | No | Yes | |
Diagram | No | No | No | |
Details (Model Review and Editing) | Yes | No | N/A | |
Constraints | Yes | No | Yes | |
Entities and Associations | Yes | No | Yes | |
Entity Attributes | Yes | No | Yes | Only described Attribute Move so content moved to Entities and Associations |
Measurements | Yes | No | Yes | |
Measurement Systems & Coordinate Systems | Yes | No | Yes | |
Messages | N/A | No | No | It's not possible to create Messagea anymore |
Observables | Yes | No | Yes | |
Packages | Yes | No | Yes | |
Platform Type/Enumeration editing | Yes | No | Yes | |
Reference Point | Yes | No | Yes | |
Semantic Matches | Yes | No | Yes | |
Services / UOPs & Message Ports | Yes | No | Yes | |
Transport Channel | Yes | No | Yes | |
View Attributes | Yes | No | Yes | |
Views | Yes | No | Yes | |
View Trace | Yes | Yes | Yes | Need one more image + What are placeholder paths? |
Integration Model Editor | No | No | No | |
[Old] Scratchpad | N/A | No | No | Obsolete page |
[Old] Diagrams | N/A | No | No | Obsolete page |
Generate | Yes | No | Yes | |
Templates - Creating and Editing Syntax | Yes | No | Yes | |
Model & Artifact Generation | Yes | No | Yes | |
Health Check | Yes | Yes | Yes | Need to confirm information on the page, add description for new health check, and add screenshots |
Impact Assessment | No | No | No | Moved to Data Modeling |
Analytics | Yes | No | Yes | Moved to Data Modeling |
Entity Usage | Yes | No | Yes | Included in Analytics page |
Semantic Equivalencies | Yes | No | Yes | Included in Analytics page. Need to removed the dedicated page as unused |
Manage | Yes | No | Yes | |
Model Structure & Sub-Structure in Phenom Portal | Yes | Yes | Partially | Renamed to Projects and Models Management |
Creating a Filtered Project | Yes | No | Yes | |
Branch (Branch Management and Content Versioning / Merging) | Yes | Yes | No | Renamed to Push, Pull, and Approve |
Change Sets | Yes | Yes | Partially | Need to update health check screenshot for new UI |
Import | No | No | No | Goes in Data Modeling |
DSDM Import | No | No | No | |
Enum-Literal Import | No | No | No | |
FACE XMI v2.1 Import | No | No | No | |
View-Characteristic Import | No | No | No | |
Migrate | N/A | No | No | Obsolete page |
Advanced Topics | N/A | No | No | Empty section |
Tutorials | Yes | No | N/A | |
Exercise: Developing an Entity Model | Yes | Yes | Yes | |
Exercise: Document Interfaces using Phenom Portal | Yes | Yes | Yes | |
PHENOM Tutorial Series | Yes | No | Partially |