Skip to content

Commit 5418a03

Browse files
committed
updated sidebar
updated sidebar
1 parent 208f645 commit 5418a03

File tree

3 files changed

+33
-28
lines changed

3 files changed

+33
-28
lines changed

_sidebar.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
* [Overview](/)
22
* Getting Started
33
* [Try out CFT Sandbox](getting-started/try-out-sandbox)
4-
* [Quick Start Guide](getting-started/sandbox-quick-start-guide)
5-
* [Glossary](getting-started/glossary)
64
* [FAQs](getting-started/faqs)

getting-started/faqs.md

+33-26
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ CFT complies with Instruction Manual (IM8) Application Infrastructure Architectu
1818

1919
**Malware scanning and Content Disarm and Reconstruct (CDR)**
2020

21-
Files are scanned for malware during transfer and malicious content is removed by the CDR functionality. Latest AV updates will be automatically applied to your files when they are being scanned.
21+
Files are scanned for malware during transfer and malicious content is removed by the CDR functionality. Latest Antivirus (AV) updates are automatically applied to your files when they are being scanned.
2222

2323
**Large file transfers**
2424

@@ -30,18 +30,23 @@ Your applications can communicate with CFT through its APIs enabling you to acce
3030

3131
**Event-driven**
3232

33-
Get notified when files are available for download either by setting up a webhook or registering your email for updates.
33+
Get notified when files are available for download either by setting up a webhook or by registering your email for updates.
3434

3535
**Audit logs**
3636

37-
View logs for file transfer activity with centralized auditing and reporting.
37+
View the audit logs for all your file transfer actvity.
3838

3939

40-
**CFT will be available as:**
40+
**CFT will be available in two options:**
4141

4242
- CFT for Backend Systems
43+
44+
The Sender and Receiver are both systems.
45+
4346
- CFT for Web and Mobile Applications
4447

48+
The Sender is an end-user who uploads files to CFT; and the receiver is a system.
49+
4550
**2. What are the benefits of using CFT?**
4651

4752
**Simple and automated file transfers -**
@@ -56,19 +61,19 @@ Increase or decrease the quantum of file transfers as per your requirement; CFT
5661
**User-defined policies and file transfer workflows -**
5762
Use policy templates to customize your file transfers.
5863

59-
**Self-service Admin Portal -**
60-
CFT's intuitive admin portal allows you to:
64+
**Self-service Admin Portal**
6165

62-
- View performance metrics in an interactive dashboard
66+
- interactive dashboard to view performance metrics
6367
- Administer and manage file transfers 
64-
- Manage your projects and users 
68+
- Manage projects and users 
6569
- Approve user requests
70+
- Generate reports
6671

6772
**3. Who are the end users?**
6873

6974
CFT has been designed for government agencies, their business partners, and vendors.
7075

71-
**4. How does I use it?**
76+
**4. How do I use it?**
7277

7378
Consider an example scenario:
7479

@@ -77,10 +82,12 @@ Agency A wants to transfer a file from the internet to its intranet.
7782
|**AS A SENDER** |**AS A RECEIVER**
7883
|--------------------------- |--------------------
7984
|Step 1: Agency A will authenticate itself to CFT system |Step 1: Agency A will receive a notification that the file is available for download
80-
|Step 2: Upload file |Step 2: Agency A will authenticate itself to CFT system
81-
| |Step 3: Download file
85+
|Step 2: Upload a file to CFT |Step 2: Agency A will authenticate itself to CFT system
86+
| |Step 3: Download the file from CFT
87+
88+
8289

83-
![Display CFT](./images/CFT for backend systems.png)
90+
![Display CFT](./images/CFT-for-backend-systems.png)
8491

8592
<Fig 1 CFT for Backend Systems>
8693

@@ -90,13 +97,13 @@ The file will not be transferred and CFT will notify the sender.
9097

9198
**6. What are the requirements to use CFT?**
9299

93-
- Sender system to send files over HTTPS
94-
- Sender system to support PGP file encryption - Public key exchange
100+
- Sender system to send files over Hypertext Transfer Protocol Secure (HTTPS)
101+
- Sender system to support Pretty Good Privacy (PGP) file encryption - Public key exchange
95102
- Receiver system requires endpoint for webhook event
96103

97104
**7. What type of encryption standards are supported?**
98105

99-
Files in CFT are encrypted in transit and at rest with industry-standard schemes like HTTPS and AWS's S3-SSE-KMS.
106+
Files in CFT are encrypted in transit and at rest with industry-standard schemes like HTTPS and Amazon Web Services (AWS) Simple Storage Service Server Side Encryption Key Management Service (S3-SSE-KMS)
100107

101108
Support for additional encryption schemes is on the roadmap.
102109

@@ -136,13 +143,13 @@ Use your TechPass credentials to log in to the CFT admin portal.
136143

137144
**2. Need more help?**
138145

139-
Send us an email at [[email protected]][[email protected]].
146+
If you need more assistance, please send us an email at [[email protected]]([email protected]).
140147

141148
### Integration
142149

143150
**1. How do I integrate CFT with my application?**
144151

145-
You can learn more about the v1 API and try it for yourself here: [CFT REST API documentation][https://docs.developer.gov.sg/docs/cft-rest-api-documentation/]
152+
You can learn more about the v1 API and try it for yourself here: [CFT REST API documentation](https://docs.developer.gov.sg/docs/cft-rest-api-documentation/)
146153

147154
We have a sample project in the works (coming soon), watch this space!
148155

@@ -154,31 +161,31 @@ We have a sample project in the works (coming soon), watch this space!
154161

155162
You need to be a TechPass user to log in to CFT admin portal.
156163

157-
If you do not have a TechPass account, click [here.][https://portal.stg.techpass.suite.gov.sg/public/home]
164+
If you do not have a TechPass account, click [here.](https://portal.stg.techpass.suite.gov.sg/public/home)
158165

159166
**2. My system has connectivity issues to CFT services**
160167

161168
Have you submitted the Firewall openings? <Insert FW rules template here>
162169

163-
Check your agency Firewall logs and CDNs (if any) for any blockage.
170+
Check your agency Firewall logs and Content Delivery Network (CDN) (if any) for any blockage.
164171

165172
### Login Issues
166173

167174
**1. I am unable to login to CFT admin portal?**
168175

169176
A TechPass account is required to access CFT admin portal.
170177

171-
If you do not have a TechPass account, click [here.][https://portal.stg.techpass.suite.gov.sg/public/home]
178+
If you do not have a TechPass account, click [here.](https://portal.stg.techpass.suite.gov.sg/public/home)
172179

173180
If you are a TechPass user, your account may have been disabled due to inactivity. You will need to enable it.
174181

175182
**2. My TechPass account is disabled? How do I enable it?**
176183

177-
Your Agency Manager will need to raise a Service Request in the [TechPass portal][https://portal.stg.techpass.suite.gov.sg/public/home] to enable your account.
184+
Your Agency Manager will need to raise a Service Request in the [TechPass portal](https://portal.stg.techpass.suite.gov.sg/public/home) to enable your account.
178185

179186
**3. How do I reset my TechPass password?**
180187

181-
You can reset password in the [TechPass portal][https://portal.stg.techpass.suite.gov.sg/public/home] to enable your account.
188+
You can reset password in the [TechPass portal](https://portal.stg.techpass.suite.gov.sg/public/home) to enable your account.
182189

183190
### Account Management Issues
184191

@@ -196,17 +203,17 @@ You will need to have the Agency Manager role to amend user roles. Also, your us
196203

197204
Here are a couple of troubleshooting steps:
198205

199-
Check if workflow status is active on the portal.
206+
- Check if workflow status is active on the portal.
200207

201-
If you need any assistance, please take note of the x-cft-trace-id request header and send us an email at [[email protected]][[email protected]]
208+
If you need any assistance, please take note of the x-cft-trace-id request header and send us an email at [[email protected]]([email protected])
202209

203210
**2. I am not able to receive files**
204211

205212
Here are a couple of troubleshooting steps:
206213

207-
Check if workflow status is active on the portal.
214+
- Check if workflow status is active on the portal.
208215

209-
If you need any assistance, please take note of the x-cft-trace-id request header and send us an email at [[email protected]][[email protected]]
216+
If you need any assistance, please take note of the x-cft-trace-id request header and send us an email at [[email protected]]([email protected])
210217

211218
**3. Will I receive any notifications if my files fail to transfer?**
212219

0 commit comments

Comments
 (0)