You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tubemq.apache.org by GitBox <gi...@apache.org> on 2020/06/06 10:35:24 UTC
[GitHub] [incubator-tubemq-website] cku328 opened a new pull request #32: [TUBEMQ-219] Fix missing web title
cku328 opened a new pull request #32:
URL: https://github.com/apache/incubator-tubemq-website/pull/32
I configured the metadata of title for each markdown page.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] cku328 commented on a change in pull request #32: [TUBEMQ-219] [website] Fix missing web title
Posted by GitBox <gi...@apache.org>.
cku328 commented on a change in pull request #32:
URL: https://github.com/apache/incubator-tubemq-website/pull/32#discussion_r436477800
##########
File path: docs/en-us/architecture.md
##########
@@ -1,3 +1,7 @@
+---
+title: Architecture - Apache TubeMQ
+---
Review comment:
Thanks @guangxuCheng for the comment.
This title is a metadata item, it is used in DocSite generation page (from markdown .md file), it is not displayed on page (html).
```
For markdown documents, docsite provides three metadata configuration items:
title, keywords, and description. At the same time, the corresponding jsx page
is rendered into static HTML and combined into the final generated page.
```
Ref. https://docsite.js.org/en-us/docs/SEO.html
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] guangxuCheng merged pull request #32: [TUBEMQ-219] [website] Fix missing web title
Posted by GitBox <gi...@apache.org>.
guangxuCheng merged pull request #32:
URL: https://github.com/apache/incubator-tubemq-website/pull/32
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] guangxuCheng commented on a change in pull request #32: [TUBEMQ-219] [website] Fix missing web title
Posted by GitBox <gi...@apache.org>.
guangxuCheng commented on a change in pull request #32:
URL: https://github.com/apache/incubator-tubemq-website/pull/32#discussion_r437166448
##########
File path: docs/en-us/architecture.md
##########
@@ -1,3 +1,7 @@
+---
+title: Architecture - Apache TubeMQ
+---
Review comment:
Metadata title is docsite's syntax not markdown, it is easy for contributors or reviewers to ignore this title when adding new document which will lead to inconsistent document formats on website. In addition, whether or not to add this title will not affect the user's reading.
I just spoke out my worries, anyway, +1 for the pr
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] guangxuCheng commented on a change in pull request #32: [TUBEMQ-219] [website] Fix missing web title
Posted by GitBox <gi...@apache.org>.
guangxuCheng commented on a change in pull request #32:
URL: https://github.com/apache/incubator-tubemq-website/pull/32#discussion_r436504426
##########
File path: docs/en-us/architecture.md
##########
@@ -1,3 +1,7 @@
+---
+title: Architecture - Apache TubeMQ
+---
Review comment:
@Technoboy- @wf123537200 What do you think? After merge the pr, when adding a new document, we need to remind the user to add the title
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] wf123537200 commented on a change in pull request #32: [TUBEMQ-219] [website] Fix missing web title
Posted by GitBox <gi...@apache.org>.
wf123537200 commented on a change in pull request #32:
URL: https://github.com/apache/incubator-tubemq-website/pull/32#discussion_r437112576
##########
File path: docs/en-us/architecture.md
##########
@@ -1,3 +1,7 @@
+---
+title: Architecture - Apache TubeMQ
+---
Review comment:
i think the title should not include ```Apache TubeMq```,it may be a trouble to remind all docs to add the title
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] cku328 commented on a change in pull request #32: [TUBEMQ-219] [website] Fix missing web title
Posted by GitBox <gi...@apache.org>.
cku328 commented on a change in pull request #32:
URL: https://github.com/apache/incubator-tubemq-website/pull/32#discussion_r437119015
##########
File path: docs/en-us/architecture.md
##########
@@ -1,3 +1,7 @@
+---
+title: Architecture - Apache TubeMQ
+---
Review comment:
@wf123537200 Do you mean the title doesn't need to include `Apache TubeMQ` suffix?
##########
File path: docs/en-us/architecture.md
##########
@@ -1,3 +1,7 @@
+---
+title: Architecture - Apache TubeMQ
+---
Review comment:
If adding title metadata to the document is cumbersome, an even more extreme approach is to modify the template file to define the title tag directly as a specified string like "Apache TubeMQ".
I think that would solve this issue as well, but I don't think it's appropriate considering the search engine optimization.
What do you guys think?
##########
File path: docs/en-us/architecture.md
##########
@@ -1,3 +1,7 @@
+---
+title: Architecture - Apache TubeMQ
+---
Review comment:
If adding title metadata to docs is cumbersome, an even more extreme approach is to modify the template file to define the title tag directly as a specified string like "Apache TubeMQ".
I think that would solve this issue as well, but I don't think it's appropriate considering the search engine optimization.
What do you guys think?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] cku328 commented on pull request #32: [TUBEMQ-219] [website] Fix missing web title
Posted by GitBox <gi...@apache.org>.
cku328 commented on pull request #32:
URL: https://github.com/apache/incubator-tubemq-website/pull/32#issuecomment-641096424
rebased latest master-branch (#36 / commit: ec0ab0c) & conflict resolved.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] guangxuCheng commented on a change in pull request #32: [TUBEMQ-219] [website] Fix missing web title
Posted by GitBox <gi...@apache.org>.
guangxuCheng commented on a change in pull request #32:
URL: https://github.com/apache/incubator-tubemq-website/pull/32#discussion_r436502911
##########
File path: docs/en-us/architecture.md
##########
@@ -1,3 +1,7 @@
+---
+title: Architecture - Apache TubeMQ
+---
Review comment:
got that.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-tubemq-website] guangxuCheng commented on a change in pull request #32: [TUBEMQ-219] [website] Fix missing web title
Posted by GitBox <gi...@apache.org>.
guangxuCheng commented on a change in pull request #32:
URL: https://github.com/apache/incubator-tubemq-website/pull/32#discussion_r436446645
##########
File path: docs/en-us/architecture.md
##########
@@ -1,3 +1,7 @@
+---
+title: Architecture - Apache TubeMQ
+---
Review comment:
We already have a title "TubeMQ Architecture". Why add a new title?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org