Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional notes in the getting started section #5697

Closed
jpcchaves opened this issue Oct 20, 2023 · 2 comments
Closed

Additional notes in the getting started section #5697

jpcchaves opened this issue Oct 20, 2023 · 2 comments
Labels
comp: clayui.com Issues related to website infrastructure or other things outside the documentation

Comments

@jpcchaves
Copy link
Member

Hello! I'm a new hire at Liferay, and I recently completed the basic Liferay training, where I had to use Clay to create a React application with Clay.

Since I have more experience in React and frontend development than my fellow new hires, it was relatively easy for me to resolve the issues that arose in the "Getting Started" section.

I'm wondering if I can contribute to Clay's documentation by adding two notes in the "Getting Started" section, where the most issues occurred. These notes would be as follows in the how-to-use-clay.md file:

> **_Important Note: Be Mindful of the Asterisk:_**
> When using the `@clayui/*` command for installation, it's crucial to remember that the asterisk (*) is a placeholder. It's not a valid package name on its own. To install a specific Clay package, you must replace the asterisk with the name of the package you require.
>
> For instance, if you want to install the "Clay Button" package, the correct command would be:
> 
> ```shell
> npm install @clayui/button or yarn add @clayui/button
<div class="clay-site-alert alert alert-warning">
	<strong class="lead">Warning</strong>
	To ensure that Clay functions correctly, please remember to import the CSS package from @clayui/css into your React entrypoint component, as demonstrated in the example below.
</div>
@jpcchaves jpcchaves added the comp: clayui.com Issues related to website infrastructure or other things outside the documentation label Oct 20, 2023
@github-actions
Copy link

Thanks for sending your Clay issue to PEDS Team.

@jpcchaves, we appreciate your contribution, however, please be informed that we have transitioned away from using GitHub issues to track and prioritize our work. At present, we are exclusively utilizing LPS tickets for issue management. Therefore, we kindly request you to create your LPS tickets for any new matters or inquiries ;)

Link for How To Open a LPS Ticket to Clay

If you are an external contributor, we strongly recommend reaching out to our support team for further assistance :)

@matuzalemsteles
Copy link
Member

Hey @jpcchaves We are using Jira for tickets right now so the bot is automatically closing issues but feel free to contribute and we support that, it would be a good addition.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp: clayui.com Issues related to website infrastructure or other things outside the documentation
Projects
None yet
Development

No branches or pull requests

2 participants