appsmithorg / appsmith-docs Goto Github PK
View Code? Open in Web Editor NEWMirror of documentation at https://docs.appsmith.com. Raise Pull requests against this repository to update the documentation
Home Page: https://docs.appsmith.com
Mirror of documentation at https://docs.appsmith.com. Raise Pull requests against this repository to update the documentation
Home Page: https://docs.appsmith.com
Hi there!
I've been setting up an AppSmith deployment authenticated with SSO and going through the JWT documentation, and I had a few questions:
<<ENV_VARIABLE>>
syntax work?From the docs:
The environment variable APPSMITH_USER_OAUTH2_ACCESS_TOKEN stores access token. You can read the value of the access token by using it in between the angular braces<<>>.
I didn't see APPSMITH_USER_OAUTH2_ACCESS_TOKEN
appear anywhere in the appsmithorg/appsmith codebase, and using double angle brackets in a datasource or query just passed along the string as a literal. Wrapping that in double curly brackets, e.g. {{<<APPSMITH_USER_OAUTH2_ACCESS_TOKEN>>}}
produces null
, but so does putting any invalid identifier between {{ }}
.
{{appsmith.user.idToken}}
supposed to be functional?From the docs:
You can read the value of an id token in your APIs/Queries by using a mustache sign {{}}.
{{appsmith.user.idToken}}
When I use {{appsmith.user.idToken}}
, I get {}
, meaning that idToken
is an empty object. Looking through the codebase, the only time idToken
appears is here, where it's set to an empty map, which matches my experience. I have SSO configured through Google and that works fine.
In this section:
https://docs.appsmith.com/tutorials/building-a-store-catalog-manager/part-2-using-forms#connecting-multiple-pages
where it says: "Type AddProductPage in Page Name field"
it must say "Type NewProductPage in Page Name field"
We're currently redesigning the sample apps, and the links will need to be updated.
Need to improve the S3 doc around how to use base64 encoding option for upload/read query
Link to the page which needs improvement :
https://github.com/appsmithorg/appsmith-docs/blob/v1.3/README.md?plain=1#L22
The embedding of the YouTube video can be improved
AFTER IMPROVEMENT:
Added the thumbnail to the youtube video as an hyperlink
Thanks for fixing these @saintmalik. But note that typo fixes won't get counted for Hacktoberfest
No problem
For example, the S3 plugin does a list-buckets
operation to test the datasource. If the configuration is correct but the credentials don't have this permission, the test operation fails. Can we make clear in the documentation on what permissions this needs so the user isn't taken by surprise?
A tutorial idea from @Pradyuman7
Anime Search Application using Appsmith
Currently, the documentation for navigateTo()
is mentioning about the second argument params
.
If we could mention how to access the parameters along with a link to appsmith.URL, that would be a nice addition.
Please cover the following topics in this guide -
For documentation guidelines, click here.
I hope start appsmith-docs locallyοΌbut I have this error
$ gitbook serve
Live reload server started on port: 35729
Press CTRL+C to quit ...
info: 8 plugins are installed
info: loading plugin "url-embed"... OK
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 178 pages
info: found 1239 asset files
error: error while generating page "README.md":
Template render error: (F:\workspace\github.com\appsmith-docs\README.md) [Line 22, Column 2]
unknown block tag: embed
This is my environmental information
I found that there is no book.json file in the project root directoryοΌIs there a plugin missing?
Third paragraph, second link private instance
gives a 404 error.
In the introduction page, we've the following
Here are five simple steps to create an app in Appsmith:
By steps, usually users understand a sequence of actions that someone need to complete in order to achieve something. The described points are not steps but are functionalities/features/use cases. Changing the text to something else seems more appropriate in this case.
As we can see the repository has no predefined Issue template, because of which there is non uniformity in the issues section.
GitHub has recently rolled out a public beta for their issue forms feature. This would allow you to create interactive issue templates and validate them π€―.
I have contributed the same for appsmith/appsmith. Would like to work the same for this repository as well!
The current documentation for the Appsmith Heroku
setup needs a lot of editing and formatting. The images aren't also clear.
Please cover the following topics in this guide -
Please make sure that your documentation has the following -
For documentation guidelines, click here.
@imknight you can work on this issue.
Please cover the following topics in this guide -
In the homepage, the "Creating an Account" section title seems inappropriate. Better phrase may be: Running Appsmith, Running the Server, How to Run etc
Please make sure that your documentation has the following -
Great work on this project. I know the work is fast paced but a periodic changelog would help. Not as fast as weekly but a periodic one.
in the section https://docs.appsmith.com/tutorials/building-a-store-catalog-manager/part-3-creating-interactive-views#accessing-properties-between-widgets of the tutorial seems to be some almost duplicate paragraphs:
We have tutorials & steps showing how to bind data returned from an API to a UI widget. But we don't seem to have any handy documentation showing the inverse. If I wish to bind data from a widget to an API / DB query, there doesn't seem to be any tutorial around this. Seems like a basic use case that we've missed out on documenting.
The Ports Unavailable section refers to an outdated line number of the file https://github.com/appsmithorg/appsmith/blob/master/deploy/install.sh
Hi,
I just noticed that the table of contents contains an unwanted entry in the Readme.md file.
I guess it is caused by the markdown heading tag, so I will remove that.
Also, I found a few grammatical errors and capitalization errors in the document(especially in the changelog file). So can I work on these?
Hi there!
I noticed that across the Docs there are multiple extened Markdown Tags in use, which do not seem to work when viewing the content on GitHub. Some examples are:
{% hint style="success" %} ... {% endhint %}
or youtube embeds:
{% embed url="https://www.youtube.com/watch?v=mzqK0QIZRLs&feature=youtu.be" caption="" %}
They appear like the following when browsing the Repo on GitHub:
How should this be handled?
Should it be kept this way or should it be changed to GitHub-supported Markdown?
An idea would be, for example, to change "success" or "error" hints to GitHub "Quotes" like this:
This is a quote
And youtube embeds could be changed to displaying the YouTube Thumbnail which links to the video on YouTube.
I'd be up to changing those things across the whole Repo, if you decide to do it that way.
Anyways, have a great day (and a great hacktoberfest!)
An
Changes that we discussed for the Working with Widgets page
Main things to do,
βββ Core Concepts
β βββ Designing an Application
β β βββ Application Layout
β β βββ Working with Widgets
Addtionally,
This issue is to track documentation for different errors that are faced by users. Users can directly, navigate through the docs from our debugger, thereby helping them solve JS/Action/Plugin errors more quickly.
More information here: https://docs.appsmith.com/troubleshooting-guide
Following are the issues that are seen frequently, and have documentation.
Data Mismatch Error - This value does not evaluate to type "Array"
Tables Widget
Data Mismatch Error - This value does not evaluate to type "Array<{ label: string, value: string }>"
DropDown Widget
Data Mismatch Error - The value does not evaluate to type Array<x: string, y: number>
Chart Widget
DatePicker Invalid Date Error - Value does not match ISO 8601 standard date string
Syntax Error- This value does not evaluate to type "Array<Object>". Transform it using JS inside '{{ }}'
Missing required field row index.
- Google Sheets Plugin
Plugin failed to parse JSON {Your JSON} with error: Unable to parse request body. Expected a row object.
Google Sheets Plugin
We don't support this as of now and this gives a wrong impression to the end user that we do.
https://docs.appsmith.com/widget-reference/table#events
There is a section here that contains references and links to the old Dropdown widget, which I believe is now the Select widget.
The old image is displayed when the user clicks on the documentation link from the google sheet query pane
When the user clicks on the documentation link from the query pane, the Image in the doc is very old it needs to be updated.
In order to do this, please create a contribution to our documentation repository by following the Documentation Contribution Guidelines
Please make sure that your documentation has the following -
The mongodb query documentation page has no example on how to write a aggregation query.
https://docs.appsmith.com/datasource-reference/querying-mongodb/mongo-syntax
Need to add few examples on it.
I've seen that some users are still using Table.selectedRow
instead of using Table.triggeredRow
which causes unintentional effects. We need to add the usage of Table.selectedRow
into the documentation to avoid this.
Please cover the following topics in this guide -
Please make sure that your documentation has the following -
SSH plugin allows server-side commands to be called and return the output through the SSH.
We need to add documentation for this feature here. Link to feature: appsmithorg/appsmith#2404
Please cover the following topics in this guide -
For documentation guidelines, click here.
In the last line of the current README.md, the url is not properly linked in the markdown. Also there is some more revamping can be done in the README.md file of the current repository.
Please cover the following topics in this guide -
Please cover the following topics in this guide -
Hey Contributors ππ» !
This issue tracks all the content ideas, assignees, and contributions received as a part of Hacktoberfest. Our primary focus is to work on different how-to guides, tutorials, and blog posts that will help developers get started on Appsmith.
To get started, please fill out the form here, and we highly recommend you to follow these guidelines. Also, before working on an issue, please discuss it with the maintainer and get it assigned to you π
This can be a great way to get started with Appsmith and contribute to our fantastic open-source project.
Feel free to share more content ideas as a comment on this issue.
On Appsmith, you can build internal applications, admin panels, CRUD dashboards, and many more. If you would like to build one and write a blog post or tutorial around it, please share your idea with us, and we will create an issue on this repo. Our editorial team will review it, and you can raise a PR to list it on the documentation. Here are some of the examples of blog posts and tutorials to help you get started.
The blog post can be published either on your blog or can be submitted to the Appsmith blog.
Please comment on what you would like to work on, and we will update this list with your name and assign the issue to you.
To check out our swag and events, please visit https://hacktoberfest.appsmith.com
Happy Hacking!
Support Forum
link in the header, routes to https://github.com/appsmithorg/appsmith/discussions, which shows Page not found
as appsmith repo's discussions feature is not enabled
The Support forum
link in the header can be changed to either https://community.appsmith.com/ or discord community invite link.
Creating this issue for @rohiraanjali to create a tutorial
Please cover the following topics in this guide -
Please cover the following topics in this guide -
The button group widget is not mentioned in the list of widgets.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. πππ
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google β€οΈ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.