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.

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

Contribution documentation improvements #5132

Merged

Conversation

nirname
Copy link
Contributor

@nirname nirname commented Dec 11, 2023

📑 Summary

Brief description about the content of your PR.

Related #2910

📏 Design Decisions

  • Tutorials moved to ecosystem because they are seemed not to be not officially supported
  • All the pages development.md, docker-development.md, code.md and documentation.md are combined together and refined, and named contributing.md.
  • CONTRIBUTING.md is now a symlink to our documentation
  • Added introduction page for contributing based on Collaborators wanted! #866 so as to purify contributing guide and describe other ways of participating in project
  • Link to contributing removed from versions sub-menu, because it is already there at the top bar
  • I noticed that in many cases we used right sidebar with all the heading included. Now displaying all the levels of heading at the right sidebar is the default behaviour. This will make access to the sections easier and enforce better planning while writing documentation so as to avoid extra headings.
  • I am not sure how many people are using GitHub directly to contribute to documentation, but I think that keeping section on "how to use Github features" is an extra for our contributing to documentation guidelines. Anyway, the overall contributing process is the same regardless of what a developer prefer - GitHub UI vs his favorite editor
  • Removed recommendation to contribute directly to development branch for docs and opening PR-s targeting master branch. My thoughts that these exceptions only make process more complicated. Better keep it uniform
  • Documentation section is partially intersects with Tidy up contribute to docs page #4899 and that is why it was taken as a reference in some sense
  • Advanced section of configuration was removed because it was empty. Some TODO's are removed as well, because they looked messy

📋 Tasks

Make sure you

Copy link

netlify bot commented Dec 11, 2023

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 36fdff8
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/65a5065fdc521b0008425907
😎 Deploy Preview https://deploy-preview-5132--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Dec 11, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (dc857f8) 43.04% compared to head (bafb991) 80.17%.

❗ Current head bafb991 differs from pull request most recent head 36fdff8. Consider uploading reports for the commit 36fdff8 to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##           develop    #5132       +/-   ##
============================================
+ Coverage    43.04%   80.17%   +37.12%     
============================================
  Files           23      167      +144     
  Lines         5018    13873     +8855     
  Branches        21      707      +686     
============================================
+ Hits          2160    11122     +8962     
+ Misses        2857     2598      -259     
- Partials         1      153      +152     
Flag Coverage Δ
e2e 86.18% <ø> (?)
unit 43.04% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 163 files with indirect coverage changes

@nirname nirname requested a review from a team December 19, 2023 00:08
@nirname nirname self-assigned this Dec 22, 2023
@nirname
Copy link
Contributor Author

nirname commented Jan 11, 2024

@sidharthv96 fixed everything, unless I had missed smth. I have a question. Some of our docs do not need mermaid code to be compiled and embedded on the page along with diagram, because diagram is only for description of the document not for description of the syntax. Thus I used mermaid-nocode keyword. But GitHub does not support that, so when using diagram solely for illustrative purposes I face a dilemma:

  • avoid diagram code embedded in the doc but sacrifice GitHub contributing guidelines appearance
  • put up with the extra code on the documentation website but support those who are using GitHub UI
    image

Ideally I would support both, but then we have to change MERMAID_EXAMPLE_KEYWORDS to something else. And that will influence other parts of documentation as well. So I decided to tackle this problem separately and after a discussion. Right now I can get rid of mermaid-nocode in my examples if needed.

@sidharthv96
Copy link
Member

In this specific case, I'd prioritize the website user over the GitHub one. Although, the website user seeing the code might not be a major issue.

Wonder if this could help. If the markdown parser gives us the full text, that would fix our problem.


```mermaid nocode
flowchart
a --> b
```


@nirname
Copy link
Contributor Author

nirname commented Jan 13, 2024

I think we will leave mermaid-nocode for now, not a big deal if someone won't see very simple and not really important diagram on GitHub directly. Lets address those keywords separately

@nirname

This comment was marked as resolved.

@sidharthv96
Copy link
Member

I have fixed the build.

@nirname
Copy link
Contributor Author

nirname commented Jan 15, 2024

@sidharthv96 updated branch so build works now

@nirname
Copy link
Contributor Author

nirname commented Jan 18, 2024

@aloisklink I remember you were asking to make CONTRIBUTING.md to be exactly the same as our website contributing documentation and combine everything in one page. This PR does exactly what you were looking for

@sidharthv96 sidharthv96 added this pull request to the merge queue Jan 18, 2024
Merged via the queue into mermaid-js:develop with commit 2525966 Jan 18, 2024
17 checks passed
@huynhicode
Copy link
Member

@nirname Great job

Perhaps we can remove the "Contributing" link from the dropdown since there is a link in the Navbar.

Screenshot 2024-01-18 at 7 53 32 AM

@nirname
Copy link
Contributor Author

nirname commented Jan 18, 2024

@huynhicode Yep, already removed

@nirname nirname deleted the docs/2910_update-contributing-guidelines branch January 18, 2024 17:13
fuxingloh pushed a commit to fuxingloh/contented that referenced this pull request Feb 3, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.7.0` ->
`10.8.0`](https://renovatebot.com/diffs/npm/mermaid/10.7.0/10.8.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.7.0/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.7.0/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>mermaid-js/mermaid (mermaid)</summary>

###
[`v10.8.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.8.0)

[Compare
Source](https://togithub.com/mermaid-js/mermaid/compare/v10.7.0...v10.8.0)

### v10.8.0

#### Features

<img width="375" alt="image"
src="https://github.com/mermaid-js/mermaid/assets/5837277/c17405fb-2a06-4f7c-9c77-5eaba6c76747">

- Adding new diagram type - Block Diagram by
[@&#8203;knsv](https://togithub.com/knsv) in
[mermaid-js/mermaid#5221

- Feature/5114 add parallel commit config by
[@&#8203;mathbraga](https://togithub.com/mathbraga) in
[mermaid-js/mermaid#5161

- Changes to Gantt Parsers to allow hashes and semicolons to titles,
sections, and task data. by
[@&#8203;FutzMonitor](https://togithub.com/FutzMonitor) in
[mermaid-js/mermaid#5095

- Feature/4653 add actor-top class to sequence diagram by
[@&#8203;Ronid1](https://togithub.com/Ronid1) in
[mermaid-js/mermaid#5241

#### Documentation

- Updated gantt chart docs to show all config options by
[@&#8203;murdoa](https://togithub.com/murdoa) in
[mermaid-js/mermaid#5192
- Contribution documentation improvements by
[@&#8203;nirname](https://togithub.com/nirname) in
[mermaid-js/mermaid#5132
- Update flowchart.md - how to use font-awesome
[#&#8203;5195](https://togithub.com/mermaid-js/mermaid/issues/5195) by
[@&#8203;arukiidou](https://togithub.com/arukiidou) in
[mermaid-js/mermaid#5196
- Add more detailed docs for Gantt tasks by
[@&#8203;sorenisanerd](https://togithub.com/sorenisanerd) in
[mermaid-js/mermaid#5194
- Docs/4974 reorder integration links by
[@&#8203;Ronid1](https://togithub.com/Ronid1) in
[mermaid-js/mermaid#5066
- docs: fix swimm link by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[mermaid-js/mermaid#5219
- Update Slack community links to Discord by
[@&#8203;Olegt0rr](https://togithub.com/Olegt0rr) in
[mermaid-js/mermaid#5225
- Docs: Mermaid chart updates by
[@&#8203;huynhicode](https://togithub.com/huynhicode) in
[mermaid-js/mermaid#5232
- Fix typos in timeline syntax samples by
[@&#8203;sblom](https://togithub.com/sblom) in
[mermaid-js/mermaid#5139

#### Bug fixes

- Bug/5059 fix external connection after updating edges by
[@&#8203;mathbraga](https://togithub.com/mathbraga) in
[mermaid-js/mermaid#5127
- \[Fix] Sequence diagram actor menu popup by
[@&#8203;vitorsss](https://togithub.com/vitorsss) in
[mermaid-js/mermaid#5160
- fix: Dompurify Hooks by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5236
- Accurate pie chart labeling for text alignment by
[@&#8203;JenningsWilliam](https://togithub.com/JenningsWilliam) in
[mermaid-js/mermaid#5141
- fix: Redirect of old URLs by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5250
- Fixed Typo in ErrorRenderer.ts by
[@&#8203;FutzMonitor](https://togithub.com/FutzMonitor) in
[mermaid-js/mermaid#5256

#### Chores

- Revert "Revert 5041 feature/4935 subgraph title margin config option"
by [@&#8203;mathbraga](https://togithub.com/mathbraga) in
[mermaid-js/mermaid#5205
- build(deps-dev): bump follow-redirects from 1.15.2 to 1.15.5 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[mermaid-js/mermaid#5200
- chore(deps): update all patch dependencies (patch) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#5150
- E2E Image comparison by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5208
- E2E test by [@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5210
- Optimise caching of test results by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5213
- Update update-browserlist.yml to fix deprecation and action fails by
[@&#8203;Abrifq](https://togithub.com/Abrifq) in
[mermaid-js/mermaid#5151
- UpdateCypress by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5228
- Use node v20 by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5248
- Convert Mindmap to TS by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5247
- chore: Add interface naming Convention by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#5254

#### New Contributors

- [@&#8203;murdoa](https://togithub.com/murdoa) made their first
contribution in
[mermaid-js/mermaid#5192
- [@&#8203;arukiidou](https://togithub.com/arukiidou) made their first
contribution in
[mermaid-js/mermaid#5196
- [@&#8203;sorenisanerd](https://togithub.com/sorenisanerd) made their
first contribution in
[mermaid-js/mermaid#5194
- [@&#8203;Ronid1](https://togithub.com/Ronid1) made their first
contribution in
[mermaid-js/mermaid#5066
- [@&#8203;Olegt0rr](https://togithub.com/Olegt0rr) made their first
contribution in
[mermaid-js/mermaid#5225
- [@&#8203;vitorsss](https://togithub.com/vitorsss) made their first
contribution in
[mermaid-js/mermaid#5160
- [@&#8203;sblom](https://togithub.com/sblom) made their first
contribution in
[mermaid-js/mermaid#5139
- [@&#8203;JenningsWilliam](https://togithub.com/JenningsWilliam) made
their first contribution in
[mermaid-js/mermaid#5141

**Full Changelog**:
mermaid-js/mermaid@v10.7.0...v10.8.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/levaintech/contented).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNTMuMiIsInVwZGF0ZWRJblZlciI6IjM3LjE1My4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants