Skip to content

Commit

Permalink
website: updates and final common rework
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Jan 31, 2025
1 parent 47e06a5 commit 97dc8d4
Show file tree
Hide file tree
Showing 21 changed files with 125 additions and 65 deletions.
3 changes: 3 additions & 0 deletions website/docs/_shared/_documentation.mdx
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@

{/* ------------------------------------------------------------------------ */}

The project documentation is currently available exclusively on
the project's [website](https://xpack.github.io/xpm/).
10 changes: 10 additions & 0 deletions website/docs/_shared/_release-schedule.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

import versionMajor from '@site/src/libs/versionMajor';
import versionMinor from '@site/src/libs/versionMinor';

{/* ------------------------------------------------------------------------ */}

## Release schedule

There are no scheduled releases; the project adheres to a continuous
release approach, with updates deployed as development progresses.
4 changes: 2 additions & 2 deletions website/docs/developer/_common/_content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

import CodeBlock from '@theme/CodeBlock';

import Prerequisites from './_prerequisites.mdx';
import GetProjectSources from './_get-project-sources.mdx';
import Prerequisites from '../_common/_prerequisites.mdx';
import GetProjectSources from '../_common/_get-project-sources.mdx';

import TestResults from '../_project/_test-results.mdx';
import StyleExceptions from '../_project/_style-exceptions.mdx';
Expand Down
4 changes: 2 additions & 2 deletions website/docs/developer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ import Content from './_common/_content.mdx';

{/* ------------------------------------------------------------------------ */}

# How to contribute to xpm

[![license](https://img.shields.io/github/license/xpack/xpm-js)](https://github.com/xpack/xpm-js/blob/master/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/xpack/xpm-js)](https://github.com/xpack/xpm-js/issues)
[![GitHub pulls](https://img.shields.io/github/issues-pr/xpack/xpm-js)](https://github.com/xpack/xpm-js/pulls/)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen)](https://standardjs.com)

# How to contribute to xpm

This page is designed for developers who plan to contribute new features
or fix bugs in the
**xPack Project Manager**
Expand Down
9 changes: 9 additions & 0 deletions website/docs/getting-started/_common/_change-log.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{/* DO NOT EDIT! */}
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}

{/* ------------------------------------------------------------------------ */}

## Change log

The release and change log is available in the repository
[`CHANGELOG.md`](https://github.com/xpack/xpm-js/blob/master/CHANGELOG.md) file.
18 changes: 0 additions & 18 deletions website/docs/getting-started/_common/_content.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,10 @@

{/* DO NOT EDIT! */}
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}

import UserDeveloperMaintainer from './_user-developer-maintainer.mdx';

import Overview from '../_project/_overview.mdx';
import Compatibility from '../_project/_compatibility.mdx';
import Status from '../_project/_status.mdx';

{/* ------------------------------------------------------------------------ */}

<UserDeveloperMaintainer />

<Overview />

## Install
Expand All @@ -29,14 +22,3 @@ the right side. Click it to copy the command.

For comprehensive installation instructions, please visit the
[Install Guide](/docs/install/) page.

<Status />

## Compatibility notices

According to [SemVer](https://semver.org) rules:

> Major version X (X.y.z | X > 0) MUST be incremented if any
backwards incompatible changes are introduced to the public API.

<Compatibility />
4 changes: 2 additions & 2 deletions website/docs/getting-started/_common/_license.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## License

The original content is released under the
Unless otherwise stated, the original content is released under the terms of the
[MIT License](https://opensource.org/license/mit/),
with all rights reserved to
with all rights reserved by
[Liviu Ionescu](https://github.com/ilg-ul).
8 changes: 8 additions & 0 deletions website/docs/getting-started/_common/_releases.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{/* DO NOT EDIT! */}
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}

{/* ------------------------------------------------------------------------ */}

## Releases

The list of releases is available in the [Releases](/docs/releases/) pages.
12 changes: 12 additions & 0 deletions website/docs/getting-started/_common/_support-and-feedback.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{/* DO NOT EDIT! */}
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}

{/* ------------------------------------------------------------------------ */}

## Support & feedback

The quick advice for getting support and providing feedback is to use the
[GitHub Discussions](https://github.com/xpack/xpm-js/discussions).

For additional information, please refer to the
[Help Centre](/docs/support/) page.
2 changes: 0 additions & 2 deletions website/docs/getting-started/glossary/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ date: 2024-11-24 18:58:00 +0300

# Terms used across the **xpm** project

## Terminology

The definitions used in the **xpm** project are listed below.

### xpm
Expand Down
46 changes: 41 additions & 5 deletions website/docs/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,66 @@ keywords:
- xpack
- xpm
- overview
- features
- benefits
- compatibility
- documentation

date: 2024-10-24 18:58:00 +0300
date: 2020-07-21 17:49:00 +0300

---

import Link from '@docusaurus/Link';

import UserDeveloperMaintainer from './_common/_user-developer-maintainer.mdx';
import License from './_common/_license.mdx';
import Credits from './_common/_credits.mdx';
import MoreCredits from './_project/_more-credits.mdx';
import EnjoyedUsing from './_common/_enjoyed-using.mdx';
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';

import Content from './_common/_content.mdx';

{/* ------------------------------------------------------------------------ */}

# Getting Started with xpm

[![license](https://img.shields.io/github/license/xpack/xpm-js)](https://github.com/xpack/xpm-js/blob/master/LICENSE)
![GitHub Repo stars](https://img.shields.io/github/stars/xpack/xpm-js)

# Getting Started with xpm
<UserDeveloperMaintainer />

<Content />

<Status />

## Documentation

<Documentation/>

<ReleaseSchedule/>

<Releases />

<ChangeLog />

<SupportAndFeedback />

## Compatibility notices

According to [SemVer](https://semver.org) rules:

> Major version X (X.y.z | X > 0) MUST be incremented if any
backwards incompatible changes are introduced to the public API.

<CompatibilityNotices />

<License />

<Credits />
Expand Down
5 changes: 2 additions & 3 deletions website/docs/install/_common/_content.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@

{/* DO NOT EDIT! */}
{/* Automatically generated from docusaurus-template-liquid/templates/docusaurus. */}

import CodeBlock from '@theme/CodeBlock';

{/* ------------------------------------------------------------------------ */}

import PrerequisitesCli from './_prerequisites-cli.mdx';
import InstallCli from './_install-cli.mdx';
import PrerequisitesCli from '../_common/_prerequisites-cli.mdx';
import InstallCli from '../_common/_install-cli.mdx';

import MoreInstall from '../_project/_more-install.mdx';

Expand Down
3 changes: 2 additions & 1 deletion website/docs/install/_common/_install-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';
import Heading from '@theme/Heading';

import NoAdministrativeRights from './_no-administrative-rights.mdx';
import NoAdministrativeRights from '../_common/_no-administrative-rights.mdx';

import TroubleshootingWindows from '../_project/_troubleshooting-windows.mdx';

{/* ------------------------------------------------------------------------ */}
Expand Down
10 changes: 5 additions & 5 deletions website/docs/install/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ import Content from './_common/_content.mdx';

{/* ------------------------------------------------------------------------ */}

[![GitHub package.json version](https://img.shields.io/github/package-json/v/xpack/xpm-js?color=green)](https://github.com/xpack/xpm-js/blob/master/package.json)
[![npm (scoped)](https://img.shields.io/npm/v/xpm?color=green)](https://www.npmjs.com/package/xpm/)
[![NPM Downloads](https://img.shields.io/npm/dw/xpm)](https://www.npmjs.com/package/xpm/)
[![NPM Downloads](https://img.shields.io/npm/d18m/xpm)](https://www.npmjs.com/package/xpm/)

# How to install xpm

[![GitHub package.json version](https://img.shields.io/github/package-json/v/xpack/xpm-js?color=blue)](https://github.com/xpack/xpm-js/blob/master/package.json)
[![NPM Version](https://img.shields.io/npm/v/xpm?color=green)](https://www.npmjs.com/package/xpm/)
[![NPM Downloads](https://img.shields.io/npm/d18m/xpm)](https://www.npmjs.com/package/xpm/)
[![NPM Downloads](https://img.shields.io/npm/dw/xpm)](https://www.npmjs.com/package/xpm/)

<Content />
6 changes: 3 additions & 3 deletions website/docs/maintainer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ import Content from './_common/_content.mdx';

{/* ------------------------------------------------------------------------ */}

[![GitHub package.json version](https://img.shields.io/github/package-json/v/xpack/xpm-js?color=green)](https://github.com/xpack/xpm-js/blob/master/package.json)
# How to make new xpm releases

[![GitHub package.json version](https://img.shields.io/github/package-json/v/xpack/xpm-js?color=blue)](https://github.com/xpack/xpm-js/blob/master/package.json)
[![npm (scoped)](https://img.shields.io/npm/v/xpm?color=green)](https://www.npmjs.com/package/xpm/)
[![license](https://img.shields.io/github/license/xpack/xpm-js)](https://github.com/xpack/xpm-js/blob/master/LICENSE)
[![CI on Push](https://github.com/xpack/xpm-js/actions/workflows/test-ci.yml/badge.svg)](https://github.com/xpack/xpm-js/actions/workflows/test-ci.yml)
[![GitHub issues](https://img.shields.io/github/issues/xpack/xpm-js)](https://github.com/xpack/xpm-js/issues)
[![GitHub pulls](https://img.shields.io/github/issues-pr/xpack/xpm-js)](https://github.com/xpack/xpm-js/pulls)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen)](https://standardjs.com)

# How to make new xpm releases

This page is designed for maintainers of the
**xPack Project Manager**
project and provides documentation on how to create new releases.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/project/about/_common/_the-author.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ and Internet technologies.
He can be reached at [`<[email protected]>`](mailto:[email protected]).
Please note, this email address is provided as a courtesy.
For all correspondence related to the **xPack Project Manager**
project, kindly use the project [support](/docs/support/) page).
project, kindly use the project [support](/docs/support/) page.
6 changes: 4 additions & 2 deletions website/docs/project/history/_project/_content.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@

{/* ------------------------------------------------------------------------ */}

### November 2017

The project was created in **November 2017**.

However, the idea of a tool to automate dependencies is
Expand All @@ -10,11 +12,11 @@ used a set of shell scripts.
The initial implementation mixed **xpm** and **npm** dependencies and
supported only source packages.

## April 2018
### April 2018

In April 2018, support for binary packages was added.

## August 2022
### August 2022

In August 2022, with the release of version 0.14,
the **xpm** dependencies were separated
Expand Down
33 changes: 17 additions & 16 deletions website/docs/support/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,13 @@ pages.

## Web pages issues

If you find any issues in the content of these pages (such as typos or
If you encounter any issues in the content of these pages (such as typos or
incorrect phrasing) or have suggestions for improving the documentation,
please share them through the
[GitHub Discussions](https://github.com/xpack/xpm-js/discussions)
pages.
Be sure you provide the full URL of the page, clearly identify the
part with the problematic section, and suggest improvements.

## Check documentation

Expand All @@ -59,27 +61,27 @@ for similar problems.

## Ask questions in GitHub Discussions

If you still could not find a solution, if you have interesting use
cases, if you have custom configurations, and generally if you have
any experience that you want to share with others,
use [GitHub Discussions](https://github.com/xpack/xpm-js/discussions)
If you still cannot find a solution, have interesting use cases,
custom configurations, or any experiences you wish to share with
others, please
use the [GitHub Discussions](https://github.com/xpack/xpm-js/discussions)
pages.
Enter a **New discussion**; use the **Q&A** category for questions,
Start a **New discussion**; use the **Q&A** category for questions,
**Ideas** for suggestions and **General** for everything else.

## Register a new support ticket only if necessary

If you are convinced that you identified a bug
or if want to contribute code to enhance the
If you are convinced that you have identified a bug
or wish to contribute code to enhance the
**xPack Project Manager**
project, register a **New Issue** in the
[GitHub Issues](https://github.com/xpack/xpm-js/issues)
tracker.

:::caution

**Do not** use the GitHub Issues tracker
for questions and support, **use the
Please **do not** use the GitHub Issues tracker
for questions and support; instead, **use the
[GitHub Discussions](https://github.com/xpack/xpm-js/discussions)** pages.

:::
Expand Down Expand Up @@ -125,13 +127,12 @@ Follow the hashtag `#xpack_project` for the latest updates.
:::caution Please, please, please!

**Do not** use
private e-mail for support, **use the
private e-mail for support; instead, **use the
[GitHub Discussions](https://github.com/xpack/xpm-js/discussions)** pages.

:::

Sending private messages will be automatically replied with
a short message including a link to this page.
The reason for this rude behaviour is simply an attempt to use
the time more efficiently; since discussions are archived, other people
having similar problems might benefit from the answers.
Private messages will receive an automated reply containing a link
to this page. This approach is not intended to be discourteous, but
rather to optimise time efficiency; as discussions are archived,
others facing similar issues may benefit from the provided answers.
4 changes: 2 additions & 2 deletions website/docs/user/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ date: 2024-10-24 23:58:00 +0300

---

import ProjectContent from './_project/_content.mdx';
import Content from './_project/_content.mdx';

{/* ------------------------------------------------------------------------ */}

Expand All @@ -24,4 +24,4 @@ import ProjectContent from './_project/_content.mdx';
This section is intended for those who plan to integrate
**xpm** into their workflows.

<ProjectContent />
<Content />
1 change: 0 additions & 1 deletion website/src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import Link from '@docusaurus/Link';
import styles from './styles.module.css';

import type { FeatureItem } from './FeatureItem';

import { FeatureList } from './CustomFeatureList';

function Feature({title, Svg, description}: FeatureItem) {
Expand Down

0 comments on commit 97dc8d4

Please sign in to comment.