🔄 synced file(s) with nebari-dev/nebari

[nebari-sensei]

synced local file(s) with nebari-dev/nebari.

Changed files

• synced local docs/docs/references/RELEASE.md with remote RELEASE.md

---

This PR was created automatically by the repo-file-sync-action workflow run #11078400861

[netlify]

✅ Deploy Preview for nebari-docs ready!

Name	Link
🔨 Latest commit	1815d21
🔍 Latest deploy log	https://app.netlify.com/sites/nebari-docs/deploys/6721252131d81e000813e9d1
😎 Deploy Preview	https://deploy-preview-526--nebari-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[kcpevey]

This PR is syncing release notes from the main repo. However, there are syntax errors with docusaurus v3. Essentially, I fixed these issues in the docusaurus v3 PR, but since this file is auto-pushed from the main repo, those changes need to be made over there.

[marcelovilla]

@kcpevey given that the release notes are automatically generated by GitHub Releases, is there anything else we can do on the docs side? Or do we need to come up with some kind of pre-processing on the GHA workflow to make whatever changes are needed?

[viniciusdc]

Hi @marcelovilla, This has been discussed previously. What we need to do to unblock this is to run the same validation we run here in the docs in the current source code to assert that these files are compatible with Docssaurus.

However, last week, I suggested that instead of performing this, it seems counterproductive, in my opinion. Instead, we could fetch the RELEASE.md from the github repo during runtime in the docs.

Here's a similar thing that I did for the schema json (though on draft):

const defaultSchema: Schema = {
    title: "ConfigSchema",
    description: "The configuration schema for Nebari.",
    type: "object",
    properties: {}
};

function useSchema(schemaUrl: string, useLocal = false) {
    const [schema, setSchema] = useState<Schema>(defaultSchema);
    const [loading, setLoading] = useState(true);
    const [error, setError] = useState<string | null>(null);

    useEffect(() => {
        if (useLocal) {
            const resolver = new Resolver();
            resolver.resolve(JSONSchema, {}).then((resolvedSchema) => {
                setSchema(resolvedSchema.result);
            });
            setLoading(false);
            setError(null);
        } else {
            async function fetchSchema() {
                try {
                    const response = await fetch(schemaUrl, { headers: { 'Accept': 'application/json' } });
                    if (!response.ok) {
                        throw new Error(`Failed to fetch schema: ${response.status} ${response.statusText}`);
                    }

                    const json = await response.json();
                    const resolver = new Resolver();
                    const resolvedSchema = await resolver.resolve(json, {});
                    setSchema(resolvedSchema.result);
                } catch (err) {
                    console.error('Error:', err);
                    setError(err.message);
                } finally {
                    setLoading(false);
                }
            }

            fetchSchema();
        }
    }, [schemaUrl, useLocal]);

    return { schema, loading, error };
}