diff --git a/.github/ISSUE_TEMPLATE/3.rfc.yml b/.github/ISSUE_TEMPLATE/3.rfc.yml index a5eef95af73..e8e4a4c25b3 100644 --- a/.github/ISSUE_TEMPLATE/3.rfc.yml +++ b/.github/ISSUE_TEMPLATE/3.rfc.yml @@ -13,18 +13,15 @@ body: attributes: label: What's the problem? 🤔 description: Write a short paragraph or bulleted list to briefly explain what you're trying to do, what outcomes you're aiming for, and any other relevant details to help us understand the motivation behind this RFC. - - type: textarea attributes: label: What are the requirements? ❓ description: Provide a list of requirements that should be met by the accepted proposal. - - type: textarea attributes: label: What are our options? 💡 description: | Have you considered alternative options for achieving your desired outcome? It's not necessary to go into too much detail here, but it can help strengthen your main proposal. - - type: textarea attributes: label: Proposed solution 🟢 @@ -35,7 +32,6 @@ body: - using diagrams to help illustrate your ideas - including code examples if you're proposing an interface or system contract - linking to relevant project briefs or wireframes - - type: textarea attributes: label: Resources and benchmarks 🔗 diff --git a/.github/ISSUE_TEMPLATE/4.design.yml b/.github/ISSUE_TEMPLATE/4.design.yml deleted file mode 100644 index f3cf6e5a2f4..00000000000 --- a/.github/ISSUE_TEMPLATE/4.design.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: Design spec 💄 -description: Describe design requirements. -labels: ['design'] -body: - - type: textarea - attributes: - label: Description - description: Description of the project. What is the problem you're trying to solve? Include any contextual links. - - type: textarea - attributes: - label: Audience - description: Who does this affect? Who will determine if this is successful (stakeholders)? - - type: textarea - attributes: - label: Goals - description: What is the purpose of this project? What are users/we getting out of this? - - type: textarea - attributes: - label: Metrics - description: How is success defined for this project? Are there specific KPIs tied to it? - - type: textarea - attributes: - label: Timeline - description: When is this due? Working backwards from there, include dates for a few drafts and feedback cycles - - type: textarea - attributes: - label: Specs - description: What are the constraints, sizes, etc? Include any links to spec sheets or detail pages. diff --git a/.github/ISSUE_TEMPLATE/4.docs-feedback.yml b/.github/ISSUE_TEMPLATE/4.docs-feedback.yml new file mode 100644 index 00000000000..ab07cd43ab4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4.docs-feedback.yml @@ -0,0 +1,48 @@ +name: Docs feedback +description: Improve documentation about MUI Toolpad. +labels: ['status: waiting for maintainer', 'support: docs-feedback'] +title: '[docs] ' +body: + - type: markdown + attributes: + value: | + Please provide a searchable summary of the issue in the title above ⬆️. + + Thanks for contributing by creating an issue! ❤️ + - type: input + attributes: + label: Search keywords + description: Your issue may have already been reported! List the keywords you've used to search the [existing issues](https://github.com/mui/mui-toolpad/issues). This will also make your issue searchable for others. + placeholder: e.g. datagrid column resizing + validations: + required: true + - type: input + id: page-url + attributes: + label: Related page + description: Which page of the documentation is this about? + placeholder: https://mui.com/toolpad/ + validations: + required: true + - type: dropdown + attributes: + label: Kind of issue + description: What kind of problem are you facing? + options: + - Unclear explanations + - Missing information + - Broken demo + - Other + validations: + required: true + - type: textarea + attributes: + label: Issue description + description: | + Let us know what went wrong when you were using this documentation and what we could do to improve it. + value: | + I was looking for ... and it appears that ... + - type: textarea + attributes: + label: Context 🔦 + description: What are you trying to accomplish? What brought you to this page? Your context can help us to come up with solutions that benefit the community as a whole. diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index e93e80dcae1..96f7575b980 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -19,7 +19,7 @@ jobs: uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL - uses: github/codeql-action/init@c0d1daa7f7e14667747d73a7dbbe8c074bc8bfe2 # v2.22.9 + uses: github/codeql-action/init@b374143c1149a9115d881581d29b8390bbcbb59c # v3.22.11 with: languages: typescript # If you wish to specify custom queries, you can do so here or in a config file. @@ -29,4 +29,4 @@ jobs: # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs # queries: security-extended,security-and-quality - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@c0d1daa7f7e14667747d73a7dbbe8c074bc8bfe2 # v2.22.9 + uses: github/codeql-action/analyze@b374143c1149a9115d881581d29b8390bbcbb59c # v3.22.11 diff --git a/.github/workflows/scorecards.yml b/.github/workflows/scorecards.yml index 5d385d300ee..c45973dc7ca 100644 --- a/.github/workflows/scorecards.yml +++ b/.github/workflows/scorecards.yml @@ -44,6 +44,6 @@ jobs: # Upload the results to GitHub's code scanning dashboard. - name: Upload to code-scanning - uses: github/codeql-action/upload-sarif@c0d1daa7f7e14667747d73a7dbbe8c074bc8bfe2 # v2.22.9 + uses: github/codeql-action/upload-sarif@b374143c1149a9115d881581d29b8390bbcbb59c # v3.22.11 with: sarif_file: results.sarif diff --git a/.github/workflows/update-monorepo.yml b/.github/workflows/update-monorepo.yml index 5be28393b16..7e7d719a79f 100644 --- a/.github/workflows/update-monorepo.yml +++ b/.github/workflows/update-monorepo.yml @@ -12,7 +12,7 @@ jobs: issues: write steps: - name: Set up Node.js ⚙️ - uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4 + uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4 with: node-version: '18.x' diff --git a/CHANGELOG.md b/CHANGELOG.md index 199205ef1eb..3c07b5bdb82 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,33 @@ # Changelog +## 0.1.42 + + + +_Dec 22, 2023_ + +A big thanks to the 5 contributors who made this release possible. Here are some highlights ✨: + +This week: a big overhaul to our query editor! Improved titles for pages in the sidebar. Support server-side row updates for the data grid. + +- ​Remove components from appDom (#3017) @Janpot +- ​Introduce pagesManifest (#3016) @Janpot +- ​Add labels to form validation properties (#3015) @Janpot +- ​Guess proper default page titles based on page name (#3014) @Janpot +- ​Remove functions worker (#3013) @Janpot +- ​Add a new query panel (#2393) @bharatkashyap +- ​Support updating rows in the data provider (#3001) @Janpot +- ​Improve styling of the application navigation (#2993) @Janpot +- ​Bring in some fixes from pnpm migration branch (#3010) @Janpot +- ​Update yarn.lock (#3008) @apedroferreira +- ​Update monorepo (#2998) @apedroferreira +- ​fix 2527, customize page name (#2850) @JerryWu1234 +- ​Fix changelog (#2995) @apedroferreira +- ​[docs] Update documentation for query panel (#3000) @bharatkashyap +- ​[docs] Fix 301 links @oliviertassinari + +All contributors of this release in alphabetical order: @apedroferreira, @bharatkashyap, @Janpot, @JerryWu1234, @oliviertassinari + ## 0.1.41 diff --git a/README.md b/README.md index e7e922aa2d4..d7b1e1b17a4 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ pnpm create toolpad-app my-toolpad-app ## Documentation -Check out our [documentation](https://mui.com/toolpad/getting-started/overview/). +Check out our [documentation](https://mui.com/toolpad/getting-started/). ## Examples diff --git a/docs/README.md b/docs/README.md index 6b80fb9f73c..30fa5a8d45a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,7 +12,7 @@ If you do not have yarn installed, select your OS and follow the instructions on _DO NOT USE NPM, use Yarn to install the dependencies._ -Visit the [MUI Toolpad documentation](https://mui.com/toolpad/getting-started/overview/). +Visit the [MUI Toolpad documentation](https://mui.com/toolpad/getting-started/). ## How can I add a new demo to the documentation? diff --git a/docs/data/pages.ts b/docs/data/pages.ts index e90801a2ca2..d4a097cd987 100644 --- a/docs/data/pages.ts +++ b/docs/data/pages.ts @@ -3,9 +3,9 @@ import componentsManifest from './toolpad/reference/components/manifest.json'; const pages: MuiPage[] = [ { - pathname: '/toolpad/getting-started', + pathname: '/toolpad/getting-started-group', children: [ - { pathname: '/toolpad/getting-started/overview' }, + { pathname: '/toolpad/getting-started', title: 'Overview' }, { pathname: '/toolpad/getting-started/installation' }, { pathname: '/toolpad/getting-started/why-toolpad', title: 'Why Toolpad?' }, { pathname: '/toolpad/getting-started/first-app', title: 'Build your first app' }, diff --git a/docs/data/toolpad/concepts/custom-functions.md b/docs/data/toolpad/concepts/custom-functions.md index a16c97ff814..63e892c9f18 100644 --- a/docs/data/toolpad/concepts/custom-functions.md +++ b/docs/data/toolpad/concepts/custom-functions.md @@ -5,7 +5,7 @@ The most powerful way of bringing data into Toolpad is through your own code. You can define functions inside `toolpad/resources` and use them when creating a query of this type. The following video shows how you can use this feature to read data from PostgreSQL. @@ -36,7 +36,7 @@ You get the following response: -{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/concepts/connecting-to-data/query-8.png", "alt": "Server-side values", "caption": "Using server-side values in custom functions", "indent": 1 }} +{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/concepts/connecting-to-data/query-8.png", "alt": "Server-side values", "caption": "Using server-side values in custom functions", "indent": 1, "aspectRatio": 6 }}