Skip to content

Commit

Permalink
chore(deps): bump @globus/static-data-portal from 1.7.1 to 1.8.0 (#9)
Browse files Browse the repository at this point in the history
Bumps
[@globus/static-data-portal](https://github.com/globus/static-data-portal)
from 1.7.1 to 1.8.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/globus/static-data-portal/releases"><code>@​globus/static-data-portal</code>'s
releases</a>.</em></p>
<blockquote>
<h2>v1.8.0</h2>
<h2><a
href="https://github.com/globus/static-data-portal/compare/1.7.1...1.8.0">1.8.0</a>
(2024-08-19)</h2>
<p>We're happy to announce the availability of many new features in the
data portal – ready for your deployment!</p>
<p>If you have any questions or issues with your portal, feel free to <a
href="https://github.com/globus/template-data-portal/issues">open a
GitHub Issue</a> or contact Globus Support at <a
href="mailto:[email protected]">[email protected]</a>.</p>
<h2>New Features</h2>
<h3>Custom Content – <code>content</code> Directory</h3>
<p>To simplify adding custom pages or documentation to your data portal,
we now support a <code>content</code> directory that allows you to host
arbitrary Markdown files. The generated portal will include these files
as pages, resulting in URL-accessible routes hosted at their designated
path.</p>
<h3>Adding Markdown-based Documentation</h3>
<p>The most common use case for the <code>content</code> directory is
hosting documentation for your users.</p>
<p><a
href="https://github.com/user-attachments/assets/6deecb45-0b63-43ff-a9cf-ae1747b79f1a">https://github.com/user-attachments/assets/6deecb45-0b63-43ff-a9cf-ae1747b79f1a</a></p>
<h3>Customizing the Landing Page Using Markdown</h3>
<p>Provide a custom <code>index.md</code> in your <code>content</code>
directory – the portal will then use this as the landing page. This
override can be helpful for including customization beyond the
properties supported in the <code>static.json</code> file.</p>
<p><a
href="https://github.com/user-attachments/assets/c37e695a-eba0-40de-a1eb-d346241c0b5d">https://github.com/user-attachments/assets/c37e695a-eba0-40de-a1eb-d346241c0b5d</a></p>
<h3>Images and Other Assets</h3>
<p>Prior to this release, images referenced in the
<code>static.json</code> file (e.g.,
<code>attributes.content.image</code>) were expected to be externally
hosted assets. <strong>With this update can now place arbitrary images
and assets in <code>content/assets</code>.</strong> These files will be
hosted similarly to the rest of your custom content and can be
referenced using relative paths in the <code>static.json</code> file and
Markdown.</p>
<p>For example, you have uploaded a file at
<code>content/assets/globus-site.png</code>, the file can be referenced
in Markdown as
<code>![](https://github.com/globus/static-data-portal/blob/HEAD/globus-site.png)</code>.</p>
<!-- raw HTML omitted -->
<h3>Advanced Use</h3>
<p>To allow you to customize even further, files in the
<code>content</code> directory support <a
href="https://mdxjs.com/">MDX</a> (<code>.mdx</code>).</p>
<p>Using MDX can be a helpful method for incorporating existing UI/UX
elements (e.g., buttons) into your Markdown-based content.</p>
<p>In addition to MDX, you <em>can</em> reach for JavaScript
(<code>.js(x)</code>) or TypeScript (<code>.ts(x)</code>) since, under
the hood, the files you provide in <code>content</code> are synced with
our <a
href="https://nextjs.org/docs/pages/building-your-application/routing/pages-and-layouts#index-routes">Next.js
<code>pages</code> directory</a>.</p>
<h3>Navigation Support</h3>
<p>While linking between Markdown files in your Custom Content might be
enough for your use case, we've also added support for extending the
portal's navigation using the <code>static.json</code> file.</p>
<pre lang="json"><code>{
  &quot;attributes&quot;: {
      &quot;navigation&quot;: {
         &quot;items&quot;: [
{ &quot;label&quot;: &quot;Example, &quot;to&quot;:
&quot;/example&quot;},
&lt;/tr&gt;&lt;/table&gt; 
</code></pre>
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/globus/static-data-portal/blob/main/CHANGELOG.md"><code>@​globus/static-data-portal</code>'s
changelog</a>.</em></p>
<blockquote>
<h2><a
href="https://github.com/globus/static-data-portal/compare/1.7.1...1.8.0">1.8.0</a>
(2024-08-19)</h2>
<h3>Features</h3>
<ul>
<li>adds support for &quot;content&quot; directory (<a
href="https://redirect.github.com/globus/static-data-portal/issues/159">#159</a>)
(<a
href="https://github.com/globus/static-data-portal/commit/8a213718b6aed456fae275ad08cc60c6f78da0ce">8a21371</a>)</li>
<li>Globus Transfer interactions have been moved to the /transfer route.
This allows for custom homepages on <code>/</code> using a
<code>index.(mdx/tsx)</code> file. (<a
href="https://redirect.github.com/globus/static-data-portal/issues/204">#204</a>)
(<a
href="https://github.com/globus/static-data-portal/commit/c282f8176a37be64e582edbd640f41ec5f04b586">c282f81</a>)</li>
<li>Improves network request performance and loading states by
implementing a cache layer. (<a
href="https://redirect.github.com/globus/static-data-portal/issues/194">#194</a>)
(<a
href="https://github.com/globus/static-data-portal/commit/070ab91789faf2424fa8bce4e1839e059a6ef9bb">070ab91</a>)</li>
<li>support content/assets/* =&gt; public/* (<a
href="https://github.com/globus/static-data-portal/commit/2e5945dd220a29782c1e860a7f796be174c73873">2e5945d</a>)</li>
<li>upgrade to <code>@​globus/sdk</code> 3.8.0 and use new Transfer
utility methods (<a
href="https://redirect.github.com/globus/static-data-portal/issues/199">#199</a>)
(<a
href="https://github.com/globus/static-data-portal/commit/989cc446d3b96a407c32f32ad46271eb8c491c76">989cc44</a>)</li>
</ul>
<h3>Fixes</h3>
<ul>
<li><code>content</code> file overrides for well-known pages (e.g.
<code>index.*</code>, <code>privacy-policy.*</code>), no longer need to
match the generator's extension (<a
href="https://redirect.github.com/globus/static-data-portal/issues/224">#224</a>)
(<a
href="https://github.com/globus/static-data-portal/commit/e3754a9ad0e22daa4c4b6e676782f39ee12b1704">e3754a9</a>)</li>
<li>Adds external link icon to external links in the main navigation and
reorders custom links. (<a
href="https://github.com/globus/static-data-portal/commit/34b691519b54826d64751e1e933c64b2224dcd13">34b6915</a>)</li>
<li>Adds loading states to &quot;Refresh&quot; and &quot;Start
Transfer&quot; buttons. (<a
href="https://github.com/globus/static-data-portal/commit/070ab91789faf2424fa8bce4e1839e059a6ef9bb">070ab91</a>)</li>
<li>adds predev script (runs prebuild) (<a
href="https://github.com/globus/static-data-portal/commit/d027fe49efe012e4e866a47824a2cbd6e9907d78">d027fe4</a>)</li>
<li>adds useLayout hook and improves rendering of pages by sharing a
Container (<a
href="https://redirect.github.com/globus/static-data-portal/issues/207">#207</a>)
(<a
href="https://github.com/globus/static-data-portal/commit/68bccd82e389ee3ff7f8d85e4449201922cf9015">68bccd8</a>)</li>
<li>Ensure full hosted base path is used in various image rendering
contexts. (<a
href="https://redirect.github.com/globus/static-data-portal/issues/218">#218</a>)
(<a
href="https://github.com/globus/static-data-portal/commit/03a3c4387ab63deb6a8d657a0117029427d87695">03a3c43</a>)</li>
<li>Ensure relative links in Markdown use Next.js Link component for
rendering. (<a
href="https://redirect.github.com/globus/static-data-portal/issues/206">#206</a>)
(<a
href="https://github.com/globus/static-data-portal/commit/34b691519b54826d64751e1e933c64b2224dcd13">34b6915</a>)</li>
<li>ensure relative paths can be used for images in Markdown (<a
href="https://redirect.github.com/globus/static-data-portal/issues/217">#217</a>)
(<a
href="https://github.com/globus/static-data-portal/commit/92ebdf3f056a52a936a5c8a3399b9403b4cc84d3">92ebdf3</a>)</li>
<li>ensure the /authorization route refreshes tokens (when returning
from an authorization_requirements prompt) (<a
href="https://redirect.github.com/globus/static-data-portal/issues/195">#195</a>)
(<a
href="https://github.com/globus/static-data-portal/commit/b042a818963d9fc98f48c596a4d4bc2172cb9c26">b042a81</a>)</li>
<li>Improves base Markdown rendering for various elements (<a
href="https://redirect.github.com/globus/static-data-portal/issues/216">#216</a>)
(<a
href="https://github.com/globus/static-data-portal/commit/b3e1f30fd10a9a07497a617e6557369c158ae371">b3e1f30</a>)</li>
<li>improves the loading states of file browsers (<a
href="https://redirect.github.com/globus/static-data-portal/issues/205">#205</a>)
(<a
href="https://github.com/globus/static-data-portal/commit/fe585599c1bbbace33fc257b2e5a1c3ae4c38367">fe58559</a>)</li>
<li>Only render &quot;Size&quot; values for files in file browsers. (<a
href="https://github.com/globus/static-data-portal/commit/a89c2d067e92dd603daad8b7c063b3670dc246bc">a89c2d0</a>)</li>
<li>Throttles the <code>&amp;lt;CollectionSearch&amp;gt;</code>
requests. (<a
href="https://github.com/globus/static-data-portal/commit/070ab91789faf2424fa8bce4e1839e059a6ef9bb">070ab91</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/globus/static-data-portal/commit/bef52b92050b5c6d0d50a6b3b82b9fb3c59afa73"><code>bef52b9</code></a>
chore(main): release 1.8.0 (<a
href="https://redirect.github.com/globus/static-data-portal/issues/160">#160</a>)</li>
<li><a
href="https://github.com/globus/static-data-portal/commit/6c64b212bf13acd535e29049cc8fc3b996c21982"><code>6c64b21</code></a>
deps: bump <code>@​playwright/test</code> from 1.46.0 to 1.46.1 (<a
href="https://redirect.github.com/globus/static-data-portal/issues/222">#222</a>)</li>
<li><a
href="https://github.com/globus/static-data-portal/commit/1aed65e8480f509919eda216e4a0002124558bb3"><code>1aed65e</code></a>
deps: bump typedoc from 0.26.5 to 0.26.6 (<a
href="https://redirect.github.com/globus/static-data-portal/issues/223">#223</a>)</li>
<li><a
href="https://github.com/globus/static-data-portal/commit/e3754a9ad0e22daa4c4b6e676782f39ee12b1704"><code>e3754a9</code></a>
fix: <code>content</code> file overrides for well-known pages (e.g.
<code>index.*</code>, `privacy-...</li>
<li><a
href="https://github.com/globus/static-data-portal/commit/03a3c4387ab63deb6a8d657a0117029427d87695"><code>03a3c43</code></a>
fix: Ensure full hosted base path is used in various image rendering
contexts...</li>
<li><a
href="https://github.com/globus/static-data-portal/commit/4f4eeb63a4627d08366543495cb15ae3b1d9570a"><code>4f4eeb6</code></a>
deps: bump typedoc-plugin-markdown from 4.2.4 to 4.2.5 (<a
href="https://redirect.github.com/globus/static-data-portal/issues/215">#215</a>)</li>
<li><a
href="https://github.com/globus/static-data-portal/commit/92ebdf3f056a52a936a5c8a3399b9403b4cc84d3"><code>92ebdf3</code></a>
fix: ensure relative paths can be used for images in Markdown (<a
href="https://redirect.github.com/globus/static-data-portal/issues/217">#217</a>)</li>
<li><a
href="https://github.com/globus/static-data-portal/commit/2e5945dd220a29782c1e860a7f796be174c73873"><code>2e5945d</code></a>
feat: support content/assets/* =&gt; public/*</li>
<li><a
href="https://github.com/globus/static-data-portal/commit/6096b593824ca2b88b97a61874bcf72c032f77e2"><code>6096b59</code></a>
ops: remove scripts/preview</li>
<li><a
href="https://github.com/globus/static-data-portal/commit/b3e1f30fd10a9a07497a617e6557369c158ae371"><code>b3e1f30</code></a>
fix: Improves base Markdown rendering for various elements (<a
href="https://redirect.github.com/globus/static-data-portal/issues/216">#216</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/globus/static-data-portal/compare/1.7.1...1.8.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=@globus/static-data-portal&package-manager=npm_and_yarn&previous-version=1.7.1&new-version=1.8.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  • Loading branch information
dependabot[bot] authored Aug 19, 2024
1 parent d0ceb4a commit 570b23a
Show file tree
Hide file tree
Showing 2 changed files with 289 additions and 156 deletions.
Loading

0 comments on commit 570b23a

Please sign in to comment.