Skip to content

Commit

Permalink
website: re-generate commons
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Feb 24, 2025
1 parent b66aa9e commit 7408e2e
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 30 deletions.
2 changes: 1 addition & 1 deletion website/blog/_common/_download-analytics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import Image from '@theme/IdealImage';
## Analytics

- npmjs.com [xpm](https://www.npmjs.com/package/xpm)
- last week downloads [![NPM Downloads](https://img.shields.io/npm/dw/xpm)](https://www.npmjs.com/package/xpm/)
- last month downloads [![NPM Downloads](https://img.shields.io/npm/dw/xpm)](https://www.npmjs.com/package/xpm/)
- total downloads [![NPM Downloads](https://img.shields.io/npm/d18m/xpm)](https://www.npmjs.com/package/xpm/)

Credit to [Shields IO](https://shields.io) for the badges.
2 changes: 2 additions & 0 deletions website/blog/tags.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@
releases:

web:

xbb:
6 changes: 3 additions & 3 deletions website/docs/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ date: 2020-07-21 17:49:00 +0300

---

import Documentation from '../_shared/_documentation.mdx';
import ReleaseSchedule from '../_shared/_release-schedule.mdx';

import UserDeveloperMaintainer from './_common/_user-developer-maintainer.mdx';
import License from './_common/_license.mdx';
import Credits from './_common/_credits.mdx';
Expand All @@ -26,9 +29,6 @@ import SupportAndFeedback from './_common/_support-and-feedback.mdx';
import ChangeLog from './_common/_change-log.mdx';
import Releases from './_common/_releases.mdx';

import Documentation from '../_shared/_documentation.mdx';
import ReleaseSchedule from '../_shared/_release-schedule.mdx';

import MoreCredits from './_project/_more-credits.mdx';
import Status from './_project/_status.mdx';
import CompatibilityNotices from './_project/_compatibility-notices.mdx';
Expand Down
26 changes: 13 additions & 13 deletions website/docs/maintainer/_common/_content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ In the `xpack/xpm-js` Git repo:

- switch to the `development` branch
- pull new changes
- if necessary, merge the `master` branch
- if necessary, merge the `website` branch
- if necessary, **merge** the `master` branch
- if necessary, **merge** the `website` branch

:::caution

Expand All @@ -54,7 +54,7 @@ kept as a legacy CommonJS dependency.
- `npm update` or edit and `npm install`
- repeat and possibly manually edit `package.json` until everything is
up to date
- commit the changes
- **commit** the changes

<DependenciesDetails />

Expand Down Expand Up @@ -136,19 +136,19 @@ to:
```

- add a new entry like _**\* v0.20.5 prepared**_
- commit with a message like _**prepare v0.20.5**_
- **commit** with a message like _**prepare v0.20.5**_

### Prepare the release

- terminate all running tasks (**Terminal****Terminate Task...**)
- switch to the `development` branch
- commit everything
- `npm run fix`
- if there are changes, commit all changes into the `development` branch
- if there are changes, **commit** all changes into the `development` branch
- `npm run test`
- `npm run pack`; check the list of packaged files, possibly
update `.npmignore`
- push all changes to GitHub
- **push** all changes to GitHub

### Set the new version

Expand All @@ -174,8 +174,8 @@ npm run generate-website-blog-post

- edit the front matter properties
- select the correct summary
- commit with _**website: blog post release 0.20.5 published**_
- push the `development` branch
- **commit** with _**website: blog post release 0.20.5 published**_
- **push** the `development` branch

## Publish the release to npmjs.com

Expand Down Expand Up @@ -214,7 +214,7 @@ published in the project

- switch to the `development` branch
- run the `website-generate-commons` script in the top `package.json`
- commit all changes
- **commit** all changes
- run the `build` script in `website/package.json`
- fix any broken links, if any

Expand All @@ -225,8 +225,8 @@ The Web site deployment is performed automatically when pushing to the
[GitHub Actions](https://github.com/xpack/xpm-js/actions/workflows/publish-github-pages.yml).

- switch to the `website` branch
- merge the `development` branch into the `website` branch
- push the `website` branch to GitHub
- **merge** the `development` branch into the `website` branch
- **push** the `website` branch to GitHub

At this moment an automated GitHub Action will generate and publish the website.

Expand All @@ -247,8 +247,8 @@ Check the result at https://xpack.github.io/xpm/.
In this Git repo:

- select the `master` branch
- merge the `development` branch into the `master` branch
- push the `master` branch to GitHub
- **merge** the `development` branch into the `master` branch
- **push** the `master` branch to GitHub

### Close milestone

Expand Down
6 changes: 3 additions & 3 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
"npm-link-helpers": "npm link @xpack/docusaurus-template-liquid @xpack/npm-packages-helper",
"npm-ci": "npm ci",
"deep-clean": "del-cli .docusaurus build node_modules package-lock.json",
"import-website-releases": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/website-import-releases.sh",
"generate-website-blog-post": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-blog-post.sh",
"generate-dependencies-details": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-dependencies-details.sh"
"import-website-releases": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/import-releases.sh --xpack",
"generate-website-blog-post": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-blog-post.sh --xpack",
"generate-dependencies-details": "bash node_modules/@xpack/docusaurus-template-liquid/maintenance-scripts/generate-dependencies-details.sh --xpack"
},
"dependencies": {
"@docusaurus/core": "3.6.3",
Expand Down
24 changes: 14 additions & 10 deletions website/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,16 @@ h2[class*="title"]
.markdown h1:first-child {
--ifm-h1-font-size: 2.5em
}
img.mac-stadium-img {
float: right;
width: 200px;
}

code {
vertical-align: baseline;
}

/* ------------------------------------------------------------------------- */

.header-home-link::before {
content: '';
Expand Down Expand Up @@ -135,6 +145,8 @@ h2[class*="title"]
background: url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat;
}

/* ------------------------------------------------------------------------- */

.getting-started-link::before {
content: '';
width: 1.5em;
Expand Down Expand Up @@ -175,7 +187,7 @@ h2[class*="title"]
background: url("/img/bulb-on-svgrepo-com-dark.svg") no-repeat;
}

/* --- */
/* ------------------------------------------------------------------------- */

.header-github-link:hover {
opacity: 0.6;
Expand All @@ -195,6 +207,7 @@ h2[class*="title"]
no-repeat;
}

/* ------------------------------------------------------------------------- */

.platform-windows::before {
content: '';
Expand Down Expand Up @@ -321,13 +334,4 @@ h2[class*="title"]
margin-left: 0.6em;
}

img.mac-stadium-img {
float: right;
width: 200px;
}

code {
vertical-align: baseline;
}

/* ------------------------------------------------------------------------- */

0 comments on commit 7408e2e

Please sign in to comment.