Code Monkey home page Code Monkey logo

docs's Introduction

Amplication Documentation

Welcome to the Amplication documentation repository! This repository contains the documentation for the Amplication open-source development platform. Amplication is a low-code development platform that allows developers to quickly build scalable and maintainable applications.

The documentation provides detailed information on how to use the platform, including tutorials, guides, and reference material. This website is built using Docusaurus 2, a modern static website generator.

Installation

npm ci

Local Development

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Contributing

We welcome contributions to the Amplication documentation! If you find an issue or want to suggest an improvement, please open a GitHub issue and then submit a pull request.

docs's People

Contributors

abrl91 avatar alonram avatar arielweinberger avatar atharva1723 avatar dericksozo avatar endalk200 avatar erik-mckelvey avatar eugenetseitlin avatar galcegla avatar harshsingh32 avatar iddan avatar jainpawan21 avatar klausmikhaelson avatar levivannoort avatar michaelsolati avatar mofogo avatar mulygottlieb avatar overbit avatar pareshhk avatar pazyanoverr avatar sachinhatikankar100 avatar shabananaik avatar shubh28698 avatar shubhxg avatar souravjain540 avatar trishitapingolia avatar tupe12334 avatar udanna avatar varghesejose2020 avatar yuval-hazaz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

๐Ÿ“– Documentation: SSO

I think we can have a short page/section that explains we support SSO
and mentioning its part of the Enterprise plan

Single Sign-On (SSO) Support for Amplication Accounts
Amplication understands the significance of a streamlined login process for your organization's members. To enhance the security and convenience of accessing your Amplication account, we offer Single Sign-On (SSO) support.

What is Single Sign-On (SSO)?
Single Sign-On (SSO) is an authentication process that enables users to access multiple applications or services with a single set of credentials. This means that you won't need to remember multiple passwords or log in repeatedly to different services within your organization's ecosystem. Once authenticated via SSO, you will gain access to all the connected services without the need for additional logins.

Who Can Use SSO with Amplication?
SSO integration for Amplication accounts is exclusively available to our Enterprise plan users. By choosing our Enterprise plan, your organization can benefit from streamlined access to Amplication through your preferred SSO provider, ensuring both convenience and security.

How to Enable SSO for Your Amplication Account
To enable Single Sign-On (SSO) for your Amplication account:

  1. Contact Us for an Upgrade: If you're interested in using the SSO feature, please reach out to us to upgrade your account to the Enterprise Plan.
  2. Setup & Integration: Once your account is upgraded, our team will handle the SSO setup and integration for you.
    It's as simple as that! We're here to ensure a smooth and hassle-free experience for our Enterprise users.

For any questions or additional support, feel free to reach out to our dedicated team.

Redis Message Broker Plugin

amplication/amplication#6615

Document the new plugin and also create the content for announcing the plugin on social media and our product updates email.
The output can be delivered as a Notion page

  1. Section for our Monthly Product Updates Email
  2. LinkedIn post
  3. Twitter Post
  4. Post for our community on Discord

Update: Plugins Page

There are several changes that can be made to the Plugins section to make it more clear and readable.

First, the introductory sections of both the How To Use Plugins page and the Plugin Development Overview page need to be rewritten for clarity.

Second, the Plugin Development Overview page should include links to other important plugin development documentation, such as events reference and architecture. This will make it easier for developers to find the information they need.

Next, the list of plugins, in the How To Use Plugins page, should be moved to its own page titled "Official Plugins" or "Available Plugins."

Some sentences need to be rewritten to more clearly explain where developers can find plugins list in the dashboard.

Image
Image

Update: Amplication's Docs Typography and Colors

I got on a call with Alex Bass and we discussed how to improve the documentation website's design to improve the user experience.

He suggested the following changes:

Alex feedback:

Make it darker color (grey color) on things that are not clicked or highlighted.

Replace the purple with white, so when you click or hover it becomes white (links)

All hyper links should be (#53DBEE) 

---

Text that is not highlighted - B7BAC7โ€
Text that active - FFFFFF
Hyper link iside the contant - 53DBEE

373D57 - bg
text - B7BAC7
Text - #FFF

---

Let's make sure everything is the same size and same font

Top menu 14px

Poppins

---

We don't need to use the purple at all for the text.
 It's


Right Sidebar:

Text that is not highlighted - B7BAC7โ€
Text that active - FFFFFF
Hyper link iside the contant - 53DBEE


Left Navbar is navigation
Right is fast navigation

Right should have the same values as the left (which is white and grey )


For breadcrumbs:

darker grey for everything until you get to the actual active page, which should be white...

Remove the darker grey background color for the breadcrumbs...

menu on the left should be 14px...

menu on the right should be 12px

----


ืืœื›ืก ื‘ืกโ€Ž3:21โ€ฏPM
D3D4DC
ืืœื›ืก ื‘ืกโ€Ž3:23โ€ฏPM
B7BAC7
53DBEE
ืืœื›ืก ื‘ืกโ€Ž3:25โ€ฏPM
Text that is not highlighted - B7BAC7โ€
Text that active - FFFFFF
Hyper link iside the contant - 53DBEEโ€โ€Ž
You3:27โ€ฏPM
##22273c
ืืœื›ืก ื‘ืกโ€Ž3:28โ€ฏPM
373D57 - bg
text - B7BAC7
*timestamp*
ืืœื›ืก ื‘ืกโ€Ž3:31โ€ฏPM
top menu - 14 px same font  - font poppins
You3:32โ€ฏPM
header background-color: #15192c
ืืœื›ืก ื‘ืกโ€Ž3:35โ€ฏPM
right menu should have the color style of the left
ืื ื™11:25
Text that is not highlighted - B7BAC7โ€
Text that active - FFFFFF
Hyper link iside the contant - 53DBEEโ€โ€โ€Ž
ืืœื›ืก ื‘ืกโ€Ž3:39โ€ฏPM
breadcrumbs 
Current link - FFFFFF
papa link  - B7BAC7โ€
icon - B7BAC7โ€โ€Ž
no need in current link bg wrap
ืืœื›ืก ื‘ืกโ€Ž3:44โ€ฏPM
side menu left -14px
fast nav on right - 12px
middle contant :
H1 - 32px semi bold
inner contant:
Title - 18px semi bold
text - 14px  regular color D3D4DC
line hight - 1.25rem (for inner content)

Make sure the arrow is around 14px. Should be tinier.

ืืœื›ืก ื‘ืกโ€Ž3:48โ€ฏPM
left menu arrow should be smaller
14px
ืืœื›ืก ื‘ืกโ€Ž3:51โ€ฏPM
bg of scroll bar - 15192C
scroll stick - 373D57

explain plugins as part of user onboarding

Plugins are one of the most valuable capabilities offered by Amplication as they allow you to quickly upgrade your services with additional capabilities such as authentication, database providers, Kafka message broker, helm chart, and many more.

I think we should create a short page to explain them and how they contribute to you as a developer working with Amplication.
this page should be presented as part of the "introduction" section. From there we can send the user to read more thoroughly about all available plugins

Update ReadMe and Contributor Documentation

Feedback from Amit Barlexz in discussion with Yuval included the following comments:

Found some difficulties when reading the README and CONTRIBUTING:
Followed the instructions on CONTIRBUTING and didn't know she should go to README to continue the setup.

Missing information includes:

  • Do I need to run npm i on the root?
  • Do I need to fork first and then clone?
  • Didnt know how to start running the server and client
  • missing some info about the packages and where to start
  • Didn't notice the "Login" button to try SAAS - navigated to GitHub and only used the Open-source version

Action Items:

  1. Review the README and CONTRIBUTING articles and change flow and structure to make the workflow more understandable.
  2. Reveiw the other issues and determine how the documentation can be enhanced.

Docs: Add Sidebar Labels to Amplication's Docs

Develop and Integrate a sidebar labels feature for Amplication's documentation to improve the navigability and user experience.

For example, "New" and "Updated" tags would help developers see what's changed and what's new at a glance.

A "5min" label could help readers estimate how long it will take to complete an article.

I see the Prisma docs doing the above too.

Finally, for paid plan users, "Enterprise" or "Pro" labels would highlight premium features.

Image

Opentelemetry Plugin

amplication/amplication#1068
Document the new plugin and also create the content for announcing the plugin on social media and our product updates email.
The output can be delivered as a Notion page

  1. Section for our Monthly Product Updates Email
  2. LinkedIn post
  3. Twitter Post
  4. Post for our community on Discord

Docs: Your first application - restructure and update

This is a very long article and doesn't provide an introductory overview of the steps to be performed.

Consider doing the following:

  1. Create an overview article with a list of the steps, each one linked to a separate topic for each part of the process.
  • Create a New App
  • Create an Entity
  • Add Entity
  • Set Access Permissions - add the new documentation in sub-topics - see amplication/amplication#2372 (comment)
  • Create Roles
  • Set Entity Permissions
  • Commit Your Changes
  • Taking your app a bit further
  1. Change the title of the article ( isn't the same process relevant even if it is not your first App?)

Docs: Search does not work on all pages

When searching for JWT, it does not appear on search results. This would appear to be related to the formatting of the headings in the article.

  1. Research the reason for the search not working in this specific case.
  2. See where this issue applies elsewhere in the docs and correct

Docs - Include Introductory article with overview of getting started steps

  1. Review the structure of the Getting Started and How to sections. Need to clarify what is the difference between Getting Started and How To, as many how tow processes are also performed when getting started.
  2. Consider adding an article after "welcome" to outline the major steps which are included in the Getting Started section.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.