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.

Sign up for GitHub

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

Jump to bottom

Improvement/artesca 10830 readme rework #684

Merged
merged 4 commits into from
Jan 24, 2024
Merged

Improvement/artesca 10830 readme rework #684

merged 4 commits into from
Jan 24, 2024

Conversation

JeanMarcMilletScality
Copy link
Contributor

Component:

Description:

Design:

Breaking Changes:

  • [] Breaking Changes

Closes: #ISSUE_NUMBER

@bert-e
Copy link
Contributor

bert-e commented Jan 18, 2024

Hello jeanmarcmilletscality,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Status report is not available.

@bert-e
Copy link
Contributor

bert-e commented Jan 18, 2024

Waiting for approval

The following approvals are needed before I can proceed with the merge:

  • the author

  • one peer

Peer approvals must include at least 1 approval from the following list:

@JeanMarcMilletScality JeanMarcMilletScality force-pushed the improvement/ARTESCA-10830-README-rework branch from 7a110f0 to 9065ead Compare January 18, 2024 15:24
MonPote
MonPote reviewed Jan 18, 2024
View reviewed changes
README.md Outdated

- Add ```@scality/core-ui``` in the ```package.json```'s dependencies of your project.

```json
"@scality/core-ui": "github:scality/core-ui.git",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be something like this :

    "@scality/core-ui": "github:scality/core-ui#0.93.0",

README.md Outdated
Comment on lines 80 to 104
const theme = {
statusHealthy: '#0AADA6',
statusHealthyRGB: '10,173,166',
statusWarning: '#F8F32B',
statusWarningRGB: '248,243,43',
statusCritical: '#E84855',
statusCriticalRGB: '232,72,85',
selectedActive: '#037AFF',
highlight: '#1A3C75',
border: '#4A4A4A',
buttonPrimary: '#2F4185',
buttonSecondary: '#595A78',
buttonDelete: '#3D0808',
infoPrimary: '#8E8EAC',
infoSecondary: '#333366',
backgroundLevel1: '#121219',
backgroundLevel2: '#323245',
backgroundLevel3: '#232331',
backgroundLevel4: '#1B1B27',
textPrimary: '#EAEAEA',
textSecondary: '#B5B5B5',
textTertiary: '#DFDFDF',
textReverse: '#000000',
textLink: '#71AEFF',
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should say that we have 2 defaults themes that they can find here : https://github.com/scality/core-ui/blob/development/1.0/src/lib/style/theme.ts

If you need to create a new one, it's possible but you need to follow the type CoreUITheme.

README.md

Run `npm run build` script when installing `@scality/core-ui` in the consuming projects.

### `npm run flow`
<br />

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part can be removed

README.md Outdated
Comment on lines 167 to 168
```sh
npm run storybook:deploy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can safely remove this since we should not deploy storybook manually.

@bert-e
Copy link
Contributor

bert-e commented Jan 23, 2024

Waiting for approval

The following approvals are needed before I can proceed with the merge:

  • the author

  • one peer

Peer approvals must include at least 1 approval from the following list:

@JeanMarcMilletScality JeanMarcMilletScality force-pushed the improvement/ARTESCA-10830-README-rework branch 2 times, most recently from 341bf55 to 020865f Compare January 24, 2024 15:44
@JeanMarcMilletScality JeanMarcMilletScality force-pushed the improvement/ARTESCA-10830-README-rework branch from 020865f to 2680821 Compare January 24, 2024 16:01
@bert-e
Copy link
Contributor

bert-e commented Jan 24, 2024

Waiting for approval

The following approvals are needed before I can proceed with the merge:

  • the author

  • one peer

Peer approvals must include at least 1 approval from the following list:

@JeanMarcMilletScality JeanMarcMilletScality marked this pull request as ready for review January 24, 2024 16:11
@JeanMarcMilletScality
Copy link
Contributor Author

/approve

@bert-e
Copy link
Contributor

bert-e commented Jan 24, 2024

In the queue

The changeset has received all authorizations and has been added to the
relevant queue(s). The queue(s) will be merged in the target development
branch(es) as soon as builds have passed.

The changeset will be merged in:

  • ✔️ development/1.0

There is no action required on your side. You will be notified here once
the changeset has been merged. In the unlikely event that the changeset
fails permanently on the queue, a member of the admin team will
contact you to help resolve the matter.

IMPORTANT

Please do not attempt to modify this pull request.

  • Any commit you add on the source branch will trigger a new cycle after the
    current queue is merged.
  • Any commit you add on one of the integration branches will be lost.

If you need this pull request to be removed from the queue, please contact a
member of the admin team now.

The following options are set: approve

@bert-e
Copy link
Contributor

bert-e commented Jan 24, 2024

I have successfully merged the changeset of this pull request
into targetted development branches:

  • ✔️ development/1.0

Please check the status of the associated issue ARTESCA-10830.

Goodbye jeanmarcmilletscality.

@bert-e bert-e merged commit fa6255e into development/1.0 Jan 24, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MonPote MonPote MonPote approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@JeanMarcMilletScality @bert-e @MonPote