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

Docs/2910 Remove n00b and fix some docs #4767

Merged

Conversation

nirname
Copy link
Contributor

@nirname nirname commented Aug 23, 2023

📑 Summary

  • Removed all n00b file names and all its occurrences in the text
  • Since some files are renamed because of n00b removal we convert them to kebab-case at one go
  • Added redirects

Related

📏 Design Decisions

📋 Tasks

Make sure you

@codecov
Copy link

codecov bot commented Aug 23, 2023

Codecov Report

Merging #4767 (ab140a0) into develop (c3160b2) will decrease coverage by 31.51%.
Report is 10 commits behind head on develop.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##           develop    #4767       +/-   ##
============================================
- Coverage    77.06%   45.55%   -31.51%     
============================================
  Files          146       53       -93     
  Lines        14569     6629     -7940     
  Branches       592       32      -560     
============================================
- Hits         11227     3020     -8207     
- Misses        3223     3608      +385     
+ Partials       119        1      -118     
Flag Coverage Δ
e2e ?
unit 45.55% <ø> (ø)

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

see 141 files with indirect coverage changes

@nirname nirname changed the title Docs/2910 Renames some and fixed some docs Docs/2910 Remove n00b and fix some docs Aug 23, 2023
docs/intro/syntax-reference.md Outdated Show resolved Hide resolved
Fixed link to mermaid-js.github.io after review

Update docs

Fixed link again
@nirname nirname force-pushed the docs/2910_renaming-docs-and-fixes branch from 41a2963 to fc19bf9 Compare August 24, 2023 19:01
@netlify
Copy link

netlify bot commented Aug 24, 2023

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit ab140a0
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/64e890161cd66c000878b42c
😎 Deploy Preview https://deploy-preview-4767--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.

@nirname nirname marked this pull request as ready for review August 24, 2023 19:21
@nirname nirname requested review from huynhicode, ashishjain0512 and sidharthv96 and removed request for huynhicode August 24, 2023 19:50
Copy link
Member

@aloisklink aloisklink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks greats to me! The only thing that seems a bit weird to me is the 4096MiB heap size change in the docker-compose.yml file, but considering that you're the expert in that file, I'll trust your judgement on it.

docker-compose.yml Outdated Show resolved Hide resolved
packages/mermaid/src/docs/intro/syntax-reference.md Outdated Show resolved Hide resolved
Copy link
Member

@sidharthv96 sidharthv96 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can merge once the pending comment is resolved.

@sidharthv96 sidharthv96 added this pull request to the merge queue Aug 25, 2023
Merged via the queue into mermaid-js:develop with commit 1bfa1a8 Aug 25, 2023
18 checks passed
fuxingloh pushed a commit to fuxingloh/contented that referenced this pull request Oct 3, 2023
[![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.4.0` ->
`10.5.0`](https://renovatebot.com/diffs/npm/mermaid/10.4.0/10.5.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.4.0/10.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.4.0/10.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

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

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

#### What's Changed

##### Features

- feat(er): add entity name alias by
[@&#8203;tomperr](https://togithub.com/tomperr) in
[mermaid-js/mermaid#4758

##### Bugfixes

- Fix Twitter fontawesome class in flowchart.md by
[@&#8203;GingerNinjaNicko](https://togithub.com/GingerNinjaNicko) in
[mermaid-js/mermaid#4723
- fix(pie): align slices and legend orders by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[mermaid-js/mermaid#4774
- Update class member handling by
[@&#8203;jgreywolf](https://togithub.com/jgreywolf) in
[mermaid-js/mermaid#4534
- fix(er): allow underscore as leading char by
[@&#8203;tomperr](https://togithub.com/tomperr) in
[mermaid-js/mermaid#4776
- Align arrows on sequence diagram by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4804
- fix: Allow hollow markers on edges by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4788
- fix: Fix for vulnerability making it possible to add javascript in
class names by [@&#8203;knsv](https://togithub.com/knsv)

##### Documentation

- Docs/2910 Remove n00b and fix some docs by
[@&#8203;nirname](https://togithub.com/nirname) in
[mermaid-js/mermaid#4767
- fix: typos by [@&#8203;omahs](https://togithub.com/omahs) in
[mermaid-js/mermaid#4801
- "CSS" instead of "css" in flowchart.md by
[@&#8203;jakeboone02](https://togithub.com/jakeboone02) in
[mermaid-js/mermaid#4797
- fix(docs): Correct repeated text in flowchart.md by
[@&#8203;andriy-koz](https://togithub.com/andriy-koz) in
[mermaid-js/mermaid#4810
- Update link to Discourse theme component by
[@&#8203;gschlager](https://togithub.com/gschlager) in
[mermaid-js/mermaid#4811
- New Mermaid Live Editor for Confluence Cloud by
[@&#8203;zhifeiyue](https://togithub.com/zhifeiyue) in
[mermaid-js/mermaid#4814
- Update classDiagram.md by
[@&#8203;jgreywolf](https://togithub.com/jgreywolf) in
[mermaid-js/mermaid#4781
- Support member definition to initialize class by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4786
- fix: Add support for `~test Array~string~` back in Class by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4805
- Added support for millisecond and second to gantt tickInterval by
[@&#8203;vertxxyz](https://togithub.com/vertxxyz) in
[mermaid-js/mermaid#4778
- Add directive support to all diagrams by preprocessing by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4759
- Update README.md by
[@&#8203;jgreywolf](https://togithub.com/jgreywolf) in
[mermaid-js/mermaid#4780

##### Chores

- chore(deps): update all minor dependencies (minor) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#4783
- chore(deps): update all patch dependencies (patch) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#4782
- chore(deps): update all patch dependencies (patch) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#4809
- chore: move `commonDb` into `diagrams/common/commonDb` by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[mermaid-js/mermaid#4802
- Use utf8 encoding in Jupyter example by
[@&#8203;jonashaag](https://togithub.com/jonashaag) in
[mermaid-js/mermaid#4701
- Update flowchart.md by [@&#8203;Ogglas](https://togithub.com/Ogglas)
in
[mermaid-js/mermaid#4792
- Update flowchart.md by [@&#8203;dsblank](https://togithub.com/dsblank)
in
[mermaid-js/mermaid#4798
- Refactor `cypress/helpers/util.ts` by
[@&#8203;RohanHandore](https://togithub.com/RohanHandore) in
[mermaid-js/mermaid#4340
- refactor: Fix typings in utils.ts by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4826
- Support ClassDefs in external diagrams by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4819
- Fix: flowchartElk Arrow overlap by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4830
- Give markers unique id's per graph by
[@&#8203;chadfawcett](https://togithub.com/chadfawcett) in
[mermaid-js/mermaid#4825

#### New Contributors

- [@&#8203;GingerNinjaNicko](https://togithub.com/GingerNinjaNicko) made
their first contribution in
[mermaid-js/mermaid#4723
- [@&#8203;omahs](https://togithub.com/omahs) made their first
contribution in
[mermaid-js/mermaid#4801
- [@&#8203;jakeboone02](https://togithub.com/jakeboone02) made their
first contribution in
[mermaid-js/mermaid#4797
- [@&#8203;andriy-koz](https://togithub.com/andriy-koz) made their first
contribution in
[mermaid-js/mermaid#4810
- [@&#8203;gschlager](https://togithub.com/gschlager) made their first
contribution in
[mermaid-js/mermaid#4811
- [@&#8203;zhifeiyue](https://togithub.com/zhifeiyue) made their first
contribution in
[mermaid-js/mermaid#4814
- [@&#8203;vertxxyz](https://togithub.com/vertxxyz) made their first
contribution in
[mermaid-js/mermaid#4778
- [@&#8203;jonashaag](https://togithub.com/jonashaag) made their first
contribution in
[mermaid-js/mermaid#4701
- [@&#8203;Ogglas](https://togithub.com/Ogglas) made their first
contribution in
[mermaid-js/mermaid#4792
- [@&#8203;dsblank](https://togithub.com/dsblank) made their first
contribution in
[mermaid-js/mermaid#4798
- [@&#8203;RohanHandore](https://togithub.com/RohanHandore) made their
first contribution in
[mermaid-js/mermaid#4340
- [@&#8203;chadfawcett](https://togithub.com/chadfawcett) made their
first contribution in
[mermaid-js/mermaid#4825

**Full Changelog**:
mermaid-js/mermaid@v10.4.0...v10.5.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:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjMiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjMiLCJ0YXJnZXRCcmFuY2giOiJtYWluIn0=-->

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

3 participants