Skip to content

Commit f6d2a5a

Browse files
VincamineVincamine
authored
Merge pull request #815 from Vincamine/w-faq
Unify FAQ sections format and styling across documentation
2 parents 5a7864e + 878821a commit f6d2a5a

4 files changed

Lines changed: 75 additions & 34 deletions

File tree

‎assets/scss/_summary.scss‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ details {
1111
font-size: 1rem;
1212
padding: 0rem 1.5rem 0rem 1.5rem;
1313
& > h6 { color: $blonde};
14-
& > p { color: $body-color};
14+
& > p {
15+
color: $body-color;
16+
margin-top: 1rem;
17+
}
1518
}
1619

1720
summary {

‎content/en/cloud/self-hosted/white-labeling/_index.md‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -179,22 +179,28 @@ $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd
179179
<!-- FUTURE: SUPPORT FOR HTTPS
180180
Optionally, to enforce HTTPS encryption for your site, select Enforce HTTPS. It can take up to 24 hours before this option is available. -->
181181

182-
## White Label FAQ
183-
184-
Frequently asked questions about white labeling.
185-
186-
**Do I need to self-host Layer5 Cloud in order to white-label it?**
182+
## Frequently asked questions about white labeling
187183

184+
<details>
185+
<summary>Do I need to self-host Layer5 Cloud in order to white-label it?</summary>
186+
188187
No, you can access and use all the same custom theming, custom dashboards, and organization preferences from the hosted version of Layer5 Cloud as well.
188+
</details>
189189

190-
**Do users have to use my custom URL to access the Organization?**
191-
190+
<details>
191+
<summary>Do users have to use my custom URL to access the Organization?</summary>
192+
192193
No. In addition to your custom URL, you'll always be able to log in from our website and access your Organization from <https://cloud.layer5.io>.
194+
</details>
193195

194-
**When I send someone a link that includes my custom URL, do they need to be logged in?**
195-
196+
<details>
197+
<summary>When I send someone a link that includes my custom URL, do they need to be logged in?</summary>
198+
196199
Yes. Users will need to be signed in through your custom URL (not through cloud.layer5.io) in order to open links that include your custom URL. Users who are not logged in can quickly do so, and subsequently, be redirected to the link you have shared.
200+
</details>
197201

198-
**Why does the custom domain work for my colleagues but not for me?**
199-
202+
<details>
203+
<summary>Why does the custom domain work for my colleagues but not for me?</summary>
204+
200205
This issue could potentially be related to your local network environment. It's possible that a local proxy client, VPN, or network accelerator on your computer might be intercepting the network request before it can reach the public internet.
206+
</details>

‎content/en/kanvas/designer/export-designs/index.md‎

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -115,24 +115,44 @@ Note:
115115

116116
## Frequently Asked Questions
117117

118-
**Q. Can I re-import a Helm Chart or Kubernetes manifest into Meshery for editing?**
119-
118+
<details>
119+
<summary>Can I re-import a Helm Chart or Kubernetes manifest into Meshery for editing?</summary>
120+
120121
You can import the resources, but design-time metadata (layout, annotations) is lost, so the graph will not reappear as originally designed.
122+
</details>
121123

122-
**Q. What gets removed in a lossy export?**
124+
<details>
125+
<summary>What gets removed in a lossy export?</summary>
126+
123127
Layout coordinates, visual grouping, comments, and any Meshery-only metadata.
128+
</details>
124129

125-
**Q. Is the Helm `.tar.gz` ready for `helm install`?**
130+
<details>
131+
<summary>Is the Helm `.tar.gz` ready for `helm install`?</summary>
132+
126133
Yes. After export, run `helm install <release> <chart.tgz>` or add it to a Helm repo.
134+
</details>
127135

128-
**Q. Should I use Helm Chart or OCI image for sharing?**
136+
<details>
137+
<summary>Should I use Helm Chart or OCI image for sharing?</summary>
138+
129139
Use Helm if your consumers deploy via Helm; use OCI if you rely on container registries for versioning.
140+
</details>
130141

131-
**Q. Do I need to be logged in to export a design?**
142+
<details>
143+
<summary>Do I need to be logged in to export a design?</summary>
144+
132145
No, login is not required. You can export as a guest user.
146+
</details>
133147

134-
**Q. Can I export someone else's published design?**
148+
<details>
149+
<summary>Can I export someone else's published design?</summary>
150+
135151
Yes. Any published design can be exported, not just your own.
152+
</details>
136153

137-
**Q. Where does the exported file go?**
154+
<details>
155+
<summary>Where does the exported file go?</summary>
156+
138157
After export, your browser will either prompt you to choose a save location or automatically download the file to your default downloads folder.
158+
</details>

‎content/en/kanvas/getting-started/import-designs.md‎

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -110,34 +110,46 @@ This is Meshery's native format and provides a lossless way to save and import y
110110

111111
## Frequently Asked Questions
112112

113-
### What happens if I drag and drop multiple files onto Kanvas at once?
114-
113+
<details>
114+
<summary>What happens if I drag and drop multiple files onto Kanvas at once?</summary>
115+
115116
Each supported file will be imported as a separate, new design. For example, if you drag three different Kubernetes manifest files onto Kanvas, three distinct designs will be created.
117+
</details>
116118

117-
### What happens if I select multiple files in the File Upload dialog?
118-
119+
<details>
120+
<summary>What happens if I select multiple files in the File Upload dialog?</summary>
121+
119122
The "File Upload" dialog is designed to process one file or package at a time. If you select multiple files in your operating system's file browser, only the last file in the selection will be processed for import. To import from multiple files, please import them individually.
123+
</details>
120124

121-
### After importing a file, can I download my original, unaltered file?
122-
125+
<details>
126+
<summary>After importing a file, can I download my original, unaltered file?</summary>
127+
123128
No. When a file is imported, it is converted into a native Meshery Design. The original source file is not stored and cannot be downloaded later. The export function will generate a new file based on the **current** state of your design.
124-
125129
> For more details, see the [Exporting Designs](/kanvas/designer/export-designs/) guide.
126130
127-
### When I import from a Kubernetes manifest, Helm chart, or other type, and choose to merge this file into an existing design, can I download my original file?
131+
</details>
128132

129-
When you choose to **merge** a new design into an existing one, Meshery first creates a separate design from your imported file before performing the merge. You can find this newly created design on your [My Designs](https://cloud.layer5.io/catalog/content/my-designs) page.
130133

131-
### Are there any differences, limitations, or special requirements for importing via File Upload, URL, or the GitHub Integration?
134+
<details>
135+
<summary>When I import from a Kubernetes manifest, Helm chart, or other type, and choose to merge this file into an existing design, can I download my original file?</summary>
136+
137+
When you choose to **merge** a new design into an existing one, Meshery first creates a separate design from your imported file before performing the merge. You can find this newly created design on your [My Designs](https://cloud.layer5.io/catalog/content/my-designs) page.
138+
</details>
132139

140+
<details>
141+
<summary>Are there any differences, limitations, or special requirements for importing via File Upload, URL, or the GitHub Integration?</summary>
142+
133143
Yes. File Upload and URL Import are simple, one-time actions for importing a single design. In contrast, the **GitHub Integration** creates a deep, persistent connection to your GitHub account.
134144

135145
It requires you to authorize the Meshery GitHub App, which then allows you to browse your repositories and select designs directly from the Meshery UI. Most importantly, this integration can enable a GitOps workflow by adding a GitHub Action to your repository that provides visual snapshots of design changes in your pull requests.
146+
</details>
136147

137-
### Is there a file size limit for imported designs?
138-
148+
<details>
149+
<summary>Is there a file size limit for imported designs?</summary>
150+
139151
There is no strict limit on the file size itself (e.g., in MB). However, there are limits on the number of **components** a design can contain, which is determined by your current subscription plan. Free accounts are limited to 100 components.
140152

141153
If you attempt to import a design that contains more components than your plan allows, the import will fail with a message stating that the component limit has been exceeded.
142-
143-
> Learn more about [plans](https://layer5.io/pricing).
154+
> Learn more about [plans](https://layer5.io/pricing).
155+
</details>

0 commit comments

Comments
 (0)