Skip to content

Add: local sistent package usage to Sistent About Page #6448

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

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open
Changes from 3 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
2694dbd
add: local sistent package usage to Sistent About Page
M-DEV-1 May 15, 2025
bca98c7
Update src/sections/Projects/Sistent/about.js
M-DEV-1 May 20, 2025
a3c660d
Update src/sections/Projects/Sistent/about.js
vishalvivekm May 21, 2025
85cc3e1
add command to reinstall sistent after removing local ref
vishalvivekm May 21, 2025
a0c4048
Merge branch 'master' into M-DEV-1/add-sistent-setup-instructions
vishalvivekm May 21, 2025
0770362
add npm link instructions, fix grammar
M-DEV-1 May 21, 2025
8917182
add verification steps for `npm link`
M-DEV-1 May 21, 2025
266a9e4
Merge branch 'master' into M-DEV-1/add-sistent-setup-instructions
M-DEV-1 May 26, 2025
0988ca4
Merge branch 'master' into M-DEV-1/add-sistent-setup-instructions
M-DEV-1 May 28, 2025
f26c150
Merge branch 'master' into M-DEV-1/add-sistent-setup-instructions
M-DEV-1 May 30, 2025
b9564cb
change ordered list to underordered for methods 1 and 2
M-DEV-1 May 30, 2025
f46d6a5
change ordered list to underordered for methods 1 and 2
M-DEV-1 May 30, 2025
24c4a4b
Merge branch 'M-DEV-1/add-sistent-setup-instructions' of github.com:M…
M-DEV-1 May 30, 2025
5a9121f
Merge branch 'master' into M-DEV-1/add-sistent-setup-instructions
M-DEV-1 Jun 27, 2025
40b6512
Merge branch 'master' into M-DEV-1/add-sistent-setup-instructions
vishalvivekm Jun 28, 2025
e0c92bf
Merge branch 'master' into M-DEV-1/add-sistent-setup-instructions
vishalvivekm Jun 28, 2025
639990b
Merge branch 'master' into M-DEV-1/add-sistent-setup-instructions
vr-varad Aug 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 57 additions & 3 deletions src/sections/Projects/Sistent/about.js
Original file line number Diff line number Diff line change
@@ -7,6 +7,7 @@ import SistentPagination from "../../../components/SistentNavigation/pagination"

import { useStyledDarkMode } from "../../../theme/app/useStyledDarkMode";
import { CodeBlock } from "./components/button/code-block";
import Code from "../../../components/CodeBlock";
import { SistentThemeProvider } from "@layer5/sistent";
import { Button } from "@layer5/sistent";

@@ -101,9 +102,62 @@ const SistentAbout = () => {
<CodeBlock name="checkbox" code={codes[1]} />
</div>

<a id="Using local Sistent">
<h2>Using your local Sistent Fork in a Project</h2>
</a>
<ol>
<li>
<b>Install your local Sistent package in the project</b>
<Code codeString="npm install &lt;path-to-sistent-on-local-machine&gt;" />
<p>Example:</p>
<Code
codeString={`# relative path
npm install ../../sistent

# absolute path
npm install /home/five/code/sistent`}
/>
<p>This will update your Sistent dependency to:</p>
<Code codeString={"\"@layer5/sistent\" : \"file:../../sistent\""} />
</li>
<li>
<b>Build your local Sistent fork</b>
<p>
After making changes to your fork, run this command in your
local Sistent package.
</p>
<Code codeString="make build" />
</li>
<li>
<b>
Run the build command in the project where your local Sistent
fork is installed
</b>
<p>Example for Meshery UI:</p>
<Code codeString="make ui-build" />
</li>
</ol>
<p>
Now, your project should reflect changes from your local Sistent
fork.
</p>
<p>
If you want to remove the local Sistent fork from your project,
run:
</p>
<Code codeString="npm uninstall @layer5/sistent" />
<p>
To contribute to Layer5 projects' UI using Sistent e.g. <a href="https://github.com/meshery/meshery/issues?q=is%3Aissue%20state%3Aopen%20label%3Acomponent%2Fui">meshery-ui</a> and others, You can
refer to {" "}
This will remove the local Sistent package from your project. You
will have to install the standard package again after running this
command.
</p>

<p>
To contribute to projects using Sistent e.g.{" "}
<a href="https://github.com/meshery/meshery/issues?q=is%3Aissue%20state%3Aopen%20label%3Acomponent%2Fui">
meshery-ui
</a>{" "}
and others, You can refer to{" "}
<a href="https://github.com/layer5io/sistent?tab=readme-ov-file#installation">
sistent set-up guide
</a>, {" "}
@@ -115,7 +169,7 @@ const SistentAbout = () => {
<a href="https://www.youtube.com/live/yiXkxbibLUU?si=Dybj5qr0VLhLWEpl">
Websites call
</a>{" "}
where experienced contributors have taught how to use sistent in
where experienced contributors have taught how to use Sistent in
various Layer5 projects.
</p>
</div>
Loading
Oops, something went wrong.