1.View design

You can see the list and details of the design by logging in ForkMe!


View list

1. Click the "List" button at the left end of the common header to display a list of designs.

2. At the far right of the common header is a button with the language you are currently using. Click to switch the display language.

3. Search for a design using the search criteria area on the far left.

4. On the list screen, the outline of each design is displayed as follows.

1: Public/Private type, number of forked designs
2: Design title 
3: Design ID
4: Cloud type icon used in design
5: rps (performance index), USD/month (approximate cost)
6: Description written by the designer
7: Operation buttons (open details, bookmarks, forks)
8: Various design indicators
9: Authorized user
10: Summary automatically generated by ForkMe! from design data

View details

1. Click "Open" for each design on the list screen to display the details screen.

2. The design report is displayed on the left side of the detail screen. The "Details" tab shows the contents of the design, and the "Files" tab shows a list of files that make up the design.
Note: These are automatically generated from the design code and cannot be edited directly.
For how to read the report, refer to "REPORT".

3. On the right side of the details screen is a code editor for editing the design.
Please refer to "Edit" for the editing method.

2.Create new design

After logging in ForkMe!, you can create a new design with the button on the design list or details screen. Please note that this operation should be performed on a PC. Not support on using smartphones.


Add new design

Press "New Design" at the bottom left of the list screen to open the Add New Design dialog. Enter the title of your design and press the "Create" button.

Also, by drag and drop the JSON / YAML format file to the "upload area (optional)" or pressing the upload button, you can add your data to your design. Please note that the file name is automatically corrected to be half-width alphanumeric characters with the json / yaml extension. (The file name of the CDD format (Cloud Design Specification) that is the main body of the design is converted to "cloudDesignRoot")

Press the save button on the design details screen to complete the creation. (Please refer Save)
Note: Please note that if you close your browser before the save is complete, the addition will be cancelled.


Duplicate from list

Press the "ForkMe!" button in the middle of each design on the list screen to open the duplicated new design. Change the code and press the save button. (Refer to "Save"
Note: Please note that if you close your browser before the save is complete, the duplication will be cancelled.


Duplicate from details

1. Click "Open" in the middle of each design on the list screen to open the details screen.

2. Then press the "ForkMe!" button at the top right of the details screen to open a new design that duplicates the design you are viewing. Change the code and press the save button. (Refer to "Save"
Please note that if you close the browser before saving is complete, the duplication will be cancelled.

3.Edit design

You can edit the designs you created / duplicated, or the designs of others who have been granted edit privileges. Please note that this operation should be performed on a PC. Not support on using smartphones.


Edit

1. Click the pull-down list at the top center of the details screen and select the file you want to edit. If you have a large number of files, it is convenient to click the "Files" tab on the upper left to display the file list. If you click the "?" mark on the right of the pull-down list, you can check the code types currently supported by ForkMe!. Check the API documents for CDS, used at 'cloudDesignRoot.'

2. After selecting the file, edit the design using the code editor on the right side of the edit screen. For the types of code that support grammar check, the code hint is displayed when you move the cursor to the keyword. Click the URL in the code hint to see the code specifications.


Report update

When you make a design change, the white button at the top center of the edit screen turns red. Press the red button to update the report.

If the edited content is not reflected correctly in the report (for example, the report is "Untitled" even though you entered the title), review the code. Code problems are underlined in yellow or red for the types of code that correspond to grammar checks.


Add / Remove Files

1. Click the pull-down list at the top center of the details screen and select "cloud Design Root". cloudDesignRoot is a "Cloud Design specification" format file that is the core of the design.

2. In the code editor, add a new filename under "resources" in the cloudDesignRoot file. If you want to delete it, remove the filename. Report update adds the new filename to the list of files and removes the deleted filename. For details on how to write resources, refer to the Resource object item in the Cloud Design specification.


Save

When you make a design change, the save button at the top right of the edit screen turns red. Press the red button to save the report.
Note: If the design does not have edit permission, the save button will not turn red even if the design is changed, and it cannot be saved.


Delete

1. Click the gear icon at the top right of the details screen to open the settings dialog.
Note: Gear icons cannot be clicked for designs without administrative privileges.

2. Click the "Delete" button in the settings dialog to delete the design.

4.Share design

You can set the disclosure range for designs created/duplicated by yourself or designs of others who have been granted administrative privileges. Please note that this operation should be performed on a PC. Not support on using smartphones.


Public / Private settings

1. Click the gear icon at the top right of the details screen to open the settings dialog.
Note: Gear icons cannot be clicked for designs without administrative privileges.

2. You can change the public status by pressing the "Publish" or "Private" button.
The initial state of the newly created/duplicated design is "private". Once published, the design will be published to all users logged in ForkMe!.
Note: Click to see public/private changes take effect immediately. Please note that it is independent of the "save" of the design.


Invite

1. Click the gear icon at the top right of the details screen to open the settings dialog.
Note: Gear icons cannot be clicked for designs without administrative privileges.

2. Press the "Invite" button to open the Add User dialog.

3. Select "Username" and "Role" and press the "Invite" button.
The user name is the nickname of the user registered in ForkMe!. You cannot select a nickname that does not exist.
Note: Clicking "Invite" will send the invitation request immediately.


Change permissions

1. Click the gear icon at the top right of the details screen to open the settings dialog.
Note: Gear icons cannot be clicked for designs without administrative privileges.

2. You can change member permissions by clicking the permissions pull-down in the settings dialog.
You can also stop members from joining by clicking the trash box icon.
Note: Click to instantly reflect authorization or deprivation. Please note that it is independent of the "save" of the design.


Record author in design

Recording the author's information in the design reveals the identity of the design. Follow the steps below to record the author in your design to help promote sharing and collaborate.

1. Click the pull-down list at the top center of the details screen and select "cloud Design Root". cloudDesignRoot is a "Cloud Design specification" format file that is the core of the design.

2. In the code editor, list the authors in "authors" in "info".
Update the report and make sure that the "Authors" at the bottom of the report is updated. For details on how to write authors, refer to the Resource object item of the Cloud Design specification.

3. Authors with the same name as ForkMe! Users with design privileges will see the "Certified" mark in the list of authors.

5.Deploy design

With a viewable design, you can download the data needed for deployment (cloud procurement and deployment). Please note that this operation should be performed on a PC. Not support on using smartphones.


Download

1. On the Files tab of the details screen, make sure your design contains one or more provisioning codes (files marked "PCD"). The provisioning code is the code that can be used for deployment (cloud procurement and deployment). Designs that do not include provisioning code are incomplete, so wait for the designer to register the code or download another design.

2. Click the download icon at the top right of the details screen to download the design file. The downloaded zip file contains all the files you can see on the Files tab.
Note: You cannot click the download icon if you are designing without viewing permission, or if you have permission but are editing. If you are editing, press the save button to complete the edit before downloading.


Deploy

1. Deploy (procure and deploy the cloud) using the provisioning code extracted from the downloaded file. The usage of the provisioning code differs depending on the cloud vendor, so please refer to the explanation of each company.

The case, deploying Amazon Web Services (AWS)
Extract the file labeled "AWS CloudFormation" in the file list and use it according to the deployment method.
The case, deploying Google Cloud Platform (GCP)
Extract the file labeled "Google Cloud Deployment Manager" in the file list and use it according to the deployment method.
The case, deploying Microsoft Azure
Extract the file labeled "Alibaba Cloud Resource Orchestration" in the file list and use it according to the deployment method.
The case, deploying Alibaba Cloud
Extract the file labeled "Alibaba Cloud Resource Orchestration" in the file list and use it according to the deployment method.
The case, deploying Terraform
Extract the file displayed as "Terraform" in the file list and use it according to the deployment method.

Appendix


ForkMe! and Reindeer


ForkMe! is provided by Reindeer Technology PTE. LTD.
Reindeer wants to reach out to all people by supporting the use of the cloud.
A society in which anyone can create services on their own will bring freedom of expression and diversity of values. We also believe that it promotes the redistribution of wealth to all and brings equal wealth and well-being to people around the world.


ForkMe!

Reindeer Technology PTE. LTD.



Trademarks

*Amazon Web Services and other AWS trademarks are trademarks of Amazon.com, Inc. or its affiliates in the United States and other countries.
*Google and Google Cloud Platform (GCP) is a registered trademark or trademarks of Google LLC.
*Micosoft and Microsoft Azure are registered trademarks or trademarks of Microsoft Corporation in the United States and other countries.
*Terraform is a registered trademark of HashiCorp, Inc.
*All other product names mentioned herein may be trademarks or registered trademarks of their respective companies.