Style guide - Revision history

Chris at 21:17, 7 January 2025

2025-01-07T21:17:59Z

← Older revision		Revision as of 17:17, 7 January 2025
Line 1:		Line 1:
	This is the Style Guide for developing documentation on this site for PHENOM Portal.		This is the Style Guide for developing documentation on this site for PHENOM Portal.

	~~[intentional_orphan]~~

	==Graphics==		==Graphics==

Chris at 21:17, 7 January 2025

2025-01-07T21:17:24Z

← Older revision		Revision as of 17:17, 7 January 2025
Line 1:		Line 1:
	This is the Style Guide for developing documentation on this site for PHENOM Portal.		This is the Style Guide for developing documentation on this site for PHENOM Portal.

			[intentional_orphan]

	==Graphics==		==Graphics==

Chris: Sorted Table to put the pages that needed changed at the top

2024-03-14T12:42:02Z

Sorted Table to put the pages that needed changed at the top

← Older revision		Revision as of 08:42, 14 March 2024
Line 42:		Line 42:
	\|-		\|-
	\| Exercise: Document Interfaces using Phenom Portal \|\| Yes \|\| '''Yes''' \|\| Yes \|\|		\| Exercise: Document Interfaces using Phenom Portal \|\| Yes \|\| '''Yes''' \|\| Yes \|\|
			\|-
			\| Diagram \|\| Yes \|\| '''Yes''' \|\| No \|\| No images have been added, only the text has been transferred
			\|-
			\| Change Sets \|\| Yes \|\| Yes \|\| Partially \|\| Need to update health check screenshot for new UI
	\|-		\|-
	\| FAQ \|\| Yes \|\| No \|\| N/A \|\|		\| FAQ \|\| Yes \|\| No \|\| N/A \|\|
Line 74:		Line 78:
	\|-		\|-
	\| Meridian Map \|\| Yes \|\| No \|\| Yes \|\|		\| Meridian Map \|\| Yes \|\| No \|\| Yes \|\|
	\|-
	~~\| Diagram \|\| Yes \|\| '''Yes''' \|\| No \|\| No images have been added, only the text has been transferred~~
	\|-		\|-
	\| Details (Model Review and Editing) \|\| Yes \|\| No \|\| N/A \|\|		\| Details (Model Review and Editing) \|\| Yes \|\| No \|\| N/A \|\|
Line 130:		Line 132:
	\|-		\|-
	\| Creating a Filtered Project \|\| Yes \|\| No \|\| Yes \|\|		\| Creating a Filtered Project \|\| Yes \|\| No \|\| Yes \|\|
	\|-
	~~\| Change Sets \|\| Yes \|\| Yes \|\| Partially \|\| Need to update health check screenshot for new UI~~
	\|-		\|-
	\| DSDM Import \|\| Yes \|\| No \|\| Yes \|\|		\| DSDM Import \|\| Yes \|\| No \|\| Yes \|\|

Chris: /* Confluence pages status */

2024-03-14T12:41:08Z

Confluence pages status

← Older revision		Revision as of 08:41, 14 March 2024
Line 18:		Line 18:
	! Page !! Added to Wiki !! Needs more work !! Updated to new UI !! Comments		! Page !! Added to Wiki !! Needs more work !! Updated to new UI !! Comments
	\|-		\|-
	\| ~~FAQ~~ \|\| Yes \|\| No \|\| ~~N/A~~ \|\|		\| Search Bar \|\| Yes \|\| '''Yes''' \|\| No \|\|
			\|-
			\| Settings \|\| Yes \|\| '''Yes''' \|\| Yes \|\| Needs to be updated with the new licensing feature
	\|-		\|-
	\| Data Model Governance \|\| Yes \|\| '''Yes''' \|\| No \|\| This page is obsolete. It needs a refresher		\| Data Model Governance \|\| Yes \|\| '''Yes''' \|\| No \|\| This page is obsolete. It needs a refresher
			\|-
			\| Subscription \|\| Yes \|\| '''Yes''' \|\| Yes \|\|
			\|-
			\| View Trace \|\| Yes \|\| '''Yes''' \|\| Yes \|\| Need one more image
			\|-
			\| Integration Model Editor \|\| Yes \|\| '''Yes''' \|\| No \|\| No images have been added, only the text has been transferred
			\|-
			\| Import \|\| Yes \|\| '''Yes''' \|\| Yes \|\| '''Need to add CSV template formatting for Constraints, Message Data Model, and Platform Types.'''
			'''Add content for Placeholders and Naive merge'''
			\|-
			\| Health Check \|\| Yes \|\| '''Yes''' \|\| Yes \|\| '''Need to confirm information on the page, add description for new health check, and add screenshots'''
			\|-
			\| Model Structure & Sub-Structure in Phenom Portal \|\| Yes \|\| '''Yes''' \|\| Partially \|\| Renamed to Projects and Models Management
			\|-
			\| Branch (Branch Management and Content Versioning / Merging) \|\| Yes \|\| '''Yes''' \|\| No \|\| Renamed to Push, Pull, and Approve
			\|-
			\| Exercise: Developing an Entity Model \|\| Yes \|\| '''Yes''' \|\| Yes \|\|
			\|-
			\| Exercise: Document Interfaces using Phenom Portal \|\| Yes \|\| '''Yes''' \|\| Yes \|\|
			\|-
			\| FAQ \|\| Yes \|\| No \|\| N/A \|\|
	\|-		\|-
	\| About Proprietary Data \|\| Yes \|\| No \|\| No \|\|		\| About Proprietary Data \|\| Yes \|\| No \|\| No \|\|
Line 37:		Line 60:
	\|-		\|-
	\| Release Notes \|\| N/A \|\| No \|\| No \|\| Obsolete, available in PHENOM		\| Release Notes \|\| N/A \|\| No \|\| No \|\| Obsolete, available in PHENOM
	\|-
	~~\| Search Bar \|\| Yes \|\| '''Yes''' \|\| No \|\|~~
	\|-
	~~\| Settings \|\| Yes \|\| '''Yes''' \|\| Yes \|\| Needs to be updated with the new licensing feature~~
	\|-		\|-
	\| Account \|\| Yes \|\| No \|\| Yes \|\|		\| Account \|\| Yes \|\| No \|\| Yes \|\|
	\|-
	~~\| Subscription \|\| Yes \|\| '''Yes''' \|\| Yes \|\|~~
	\|-		\|-
	\| Navigate \|\| Yes \|\| No \|\| Yes \|\| Renamed to Data Modeling		\| Navigate \|\| Yes \|\| No \|\| Yes \|\| Renamed to Data Modeling
Line 91:		Line 108:
	\|-		\|-
	\| Views \|\| Yes \|\| No \|\| Yes \|\|		\| Views \|\| Yes \|\| No \|\| Yes \|\|
	\|-
	~~\| View Trace \|\| Yes \|\| '''Yes''' \|\| Yes \|\| Need one more image~~
	\|-
	~~\| Integration Model Editor \|\| Yes \|\| '''Yes''' \|\| No \|\| No images have been added, only the text has been transferred~~
	\|-		\|-
	\| [Old] Scratchpad \|\| N/A \|\| No \|\| No \|\| Obsolete page		\| [Old] Scratchpad \|\| N/A \|\| No \|\| No \|\| Obsolete page
Line 105:		Line 118:
	\|-		\|-
	\| Model & Artifact Generation \|\| 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 \|\| N/A \|\| No \|\| No \|\| Was removed in the new UI		\| Impact Assessment \|\| N/A \|\| No \|\| No \|\| Was removed in the new UI
Line 117:		Line 128:
	\|-		\|-
	\| Manage \|\| Yes \|\| No \|\| Yes \|\|		\| 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 \|\|		\| 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		\| Change Sets \|\| Yes \|\| Yes \|\| Partially \|\| Need to update health check screenshot for new UI
	\|-
	~~\| Import \|\| Yes \|\| '''Yes''' \|\| Yes \|\| '''Need to add CSV template formatting for Constraints, Message Data Model, and Platform Types.'''~~
	~~'''Add content for Placeholders and Naive merge'''~~
	\|-		\|-
	\| DSDM Import \|\| Yes \|\| No \|\| Yes \|\|		\| DSDM Import \|\| Yes \|\| No \|\| Yes \|\|
Line 142:		Line 146:
	\|-		\|-
	\| Tutorials \|\| Yes \|\| No \|\| N/A \|\|		\| 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 \|\|		\| PHENOM Tutorial Series \|\| Yes \|\| No \|\| Partially \|\|
	\|}		\|}

Chris: /* Confluence pages status */

2024-03-14T12:39:08Z

Confluence pages status

← Older revision		Revision as of 08:39, 14 March 2024
Line 34:		Line 34:
	\| Login \|\| Yes \|\| No \|\| N/A \|\|		\| Login \|\| Yes \|\| No \|\| N/A \|\|
	\|-		\|-
	\| Dashboard \|\| Yes \|\| ~~'''Yes'''~~ \|\| Yes \|\|		\| Dashboard \|\| Yes \|\| No \|\| Yes \|\|
	\|-		\|-
	\| Release Notes \|\| N/A \|\| No \|\| No \|\| Obsolete, available in PHENOM		\| Release Notes \|\| N/A \|\| No \|\| No \|\| Obsolete, available in PHENOM

Chris: /* Confluence pages status */

2024-03-13T21:21:01Z

Confluence pages status

← Older revision		Revision as of 17:21, 13 March 2024
Line 34:		Line 34:
	\| Login \|\| Yes \|\| No \|\| N/A \|\|		\| Login \|\| Yes \|\| No \|\| N/A \|\|
	\|-		\|-
	\| Dashboard \|\| Yes \|\| '''Yes''' \|\| No \|\|		\| Dashboard \|\| Yes \|\| '''Yes''' \|\| Yes \|\|
	\|-		\|-
	\| Release Notes \|\| N/A \|\| No \|\| No \|\| Obsolete, available in PHENOM		\| Release Notes \|\| N/A \|\| No \|\| No \|\| Obsolete, available in PHENOM

Chris: /* Confluence pages status */

2024-03-13T21:07:33Z

Confluence pages status

← Older revision		Revision as of 17:07, 13 March 2024
Line 18:		Line 18:
	! Page !! Added to Wiki !! Needs more work !! Updated to new UI !! Comments		! Page !! Added to Wiki !! Needs more work !! Updated to new UI !! Comments
	\|-		\|-
	\| FAQ \|\| Yes \|\| No \|\| No \|\|		\| FAQ \|\| Yes \|\| No \|\| N/A \|\|
	\|-		\|-
	\| Data Model Governance \|\| Yes \|\| '''Yes''' \|\| No \|\| This page is obsolete. It needs a refresher		\| Data Model Governance \|\| Yes \|\| '''Yes''' \|\| No \|\| This page is obsolete. It needs a refresher

Nathalie: /* Confluence pages status */

2022-10-26T19:29:00Z

Confluence pages status

← Older revision		Revision as of 15:29, 26 October 2022
Line 40:		Line 40:
	\| Search Bar \|\| Yes \|\| '''Yes''' \|\| No \|\|		\| Search Bar \|\| Yes \|\| '''Yes''' \|\| No \|\|
	\|-		\|-
	\| Settings \|\| Yes \|\| '''Yes''' \|\| Yes \|\|		\| Settings \|\| Yes \|\| '''Yes''' \|\| Yes \|\| Needs to be updated with the new licensing feature
	\|-		\|-
	\| Account \|\| Yes \|\| No \|\| Yes \|\|		\| Account \|\| Yes \|\| No \|\| Yes \|\|

Nathalie: /* Confluence pages status */

2022-10-26T19:28:03Z

Confluence pages status

← Older revision		Revision as of 15:28, 26 October 2022
Line 20:		Line 20:
	\| FAQ \|\| Yes \|\| No \|\| No \|\|		\| FAQ \|\| Yes \|\| No \|\| No \|\|
	\|-		\|-
	\| Data Model Governance \|\| Yes \|\| '''Yes''' \|\| No \|\|		\| Data Model Governance \|\| Yes \|\| '''Yes''' \|\| No \|\| This page is obsolete. It needs a refresher
	\|-		\|-
	\| About Proprietary Data \|\| Yes \|\| No \|\| No \|\|		\| About Proprietary Data \|\| Yes \|\| No \|\| No \|\|

Nathalie: /* Confluence pages status */

2022-10-26T19:26:29Z

Confluence pages status

← Older revision		Revision as of 15:26, 26 October 2022
Line 44:		Line 44:
	\| Account \|\| Yes \|\| No \|\| Yes \|\|		\| Account \|\| Yes \|\| No \|\| Yes \|\|
	\|-		\|-
	\| Subscription \|\| '''No''' \|\| ~~No \|\| No~~ \|\|		\| Subscription \|\| Yes \|\| '''Yes''' \|\| Yes \|\|
	\|-		\|-
	\| Navigate \|\| Yes \|\| No \|\| Yes \|\| Renamed to Data Modeling		\| Navigate \|\| Yes \|\| No \|\| Yes \|\| Renamed to Data Modeling