Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
Documentation
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Avera
Documentation
Commits
52b8628d
Commit
52b8628d
authored
3 months ago
by
dakkar
Browse files
Options
Downloads
Patches
Plain Diff
some docs for contributors - fix
#20
parent
88899709
Loading
Loading
Loading
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
CONTRIBUTING.md
+23
-0
23 additions, 0 deletions
CONTRIBUTING.md
README.md
+4
-1
4 additions, 1 deletion
README.md
with
27 additions
and
1 deletion
CONTRIBUTING.md
0 → 100644
+
23
−
0
View file @
52b8628d
# How to contribute
This documentation is built with Hugo plus Hyas.
To build locally:
```
bash
npm
install
npm run build
```
To contribute some changes:
*
work on a branch
*
make your changes (usually inside
`content/`
)
*
check how your changes look by running
`npm run dev`
and pointing
your browser at the web servers it creates
*
once you're done,
`npm run lint`
to check your formatting
*
commit, push, open a MR on the GitLab
A word about the
`weight:`
attribute of pages: it's used to sort pages
for the "next" / "prev" links at the bottom. If you add a new page,
make sure it's slotted in a sensible place in that order.
This diff is collapsed.
Click to expand it.
README.md
+
4
−
1
View file @
52b8628d
# Documentation
TBD
This is the documentation repository for the Sharkey project, see
https://activitypub.software/TransFem-org/Sharkey/
It's published at https://docs.joinsharkey.org/
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment