Skip to content

[doc] Use related path for img#10325

Merged
zhongjiajie merged 7 commits intoapache:devfrom
zhongjiajie:f-doc-related-img-path
Jun 2, 2022
Merged

[doc] Use related path for img#10325
zhongjiajie merged 7 commits intoapache:devfrom
zhongjiajie:f-doc-related-img-path

Conversation

@zhongjiajie
Copy link
Copy Markdown
Member

Use related path in our docs for imgs, previous
can not use because website need the absolute path
from root directory, and after we merged
apache/dolphinscheduler-website#789 we have covert
function to do that

close: #9426

@zhongjiajie zhongjiajie self-assigned this Jun 1, 2022
@zhongjiajie zhongjiajie added minor Chore Chores about the project, like code clean, typo, etc. document labels Jun 1, 2022
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jun 1, 2022

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 40.47%. Comparing base (6828c9e) to head (9c9d1e1).
⚠️ Report is 2238 commits behind head on dev.

Additional details and impacted files
@@             Coverage Diff              @@
##                dev   #10325      +/-   ##
============================================
+ Coverage     40.45%   40.47%   +0.01%     
- Complexity     4779     4782       +3     
============================================
  Files           868      868              
  Lines         35301    35301              
  Branches       3931     3931              
============================================
+ Hits          14282    14287       +5     
+ Misses        19589    19587       -2     
+ Partials       1430     1427       -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Use related path in our docs for imgs, previous
can not use because website need the absolute path
from root directory, and after we merged
apache/dolphinscheduler-website#789 we have covert
function to do that

close: apache#9426
@zhongjiajie zhongjiajie force-pushed the f-doc-related-img-path branch from 106b955 to fba58d2 Compare June 1, 2022 09:55
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Jun 1, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@zhongjiajie zhongjiajie marked this pull request as ready for review June 1, 2022 12:44
@zhongjiajie zhongjiajie requested a review from Tianqi-Dotes as a code owner June 1, 2022 12:44
@zhongjiajie
Copy link
Copy Markdown
Member Author

PTAL @QuakeWang

Copy link
Copy Markdown
Contributor

@QuakeWang QuakeWang left a comment

Choose a reason for hiding this comment

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

The image formatting part of the document contains HTML and it is recommended that this be changed to MarkDown format.


<p align="center">
<img src="/img/architecture-1.3.0.jpg" alt="System architecture diagram" width="70%" />
<img src="../../../img/architecture-1.3.0.jpg" alt="System architecture diagram" width="70%" />
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

If possible, we can use markdown instead of html : )

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I think it is out of this PR or issue scope, and we already have a some related issue in #8391, and we can fix this issue in that PR. WDTY?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it is out of this PR or issue scope, and we already have a some related issue in #8391, and we can fix this issue in that PR. WDTY?

Ok, I have approved it!

Copy link
Copy Markdown
Contributor

@QuakeWang QuakeWang left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Member

@SbloodyS SbloodyS left a comment

Choose a reason for hiding this comment

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

+1

@zhongjiajie zhongjiajie merged commit 12fdd9b into apache:dev Jun 2, 2022
@zhongjiajie zhongjiajie deleted the f-doc-related-img-path branch June 2, 2022 15:28
@zhongjiajie zhongjiajie modified the milestones: 3.1.0-alpha, 3.0.0-beta-2 Jun 20, 2022
@zhongjiajie
Copy link
Copy Markdown
Member Author

I add milestones to 3.0.0-alpha which will be directly release from dev branch

ITBOX-ITBOY pushed a commit to ITBOX-ITBOY/dolphinscheduler that referenced this pull request Jul 8, 2022
Use related path in our docs for imgs, previous
can not use because website need the absolute path
from root directory, and after we merged
apache/dolphinscheduler-website#789 we have covert
function to do that

close: apache#9426
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

document minor Chore Chores about the project, like code clean, typo, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] [Doc] Image can not display properly

4 participants