[jira] [Commented] (HDDS-89) Create ozone specific inline documentation as part of the buld
[
https://issues.apache.org/jira/browse/HDDS-89?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16484070#comment-16484070
]
Elek, Marton commented on HDDS-89:
--
There should be some files in the content directory:
{code}
ls -lah hadoop-ozone/docs/content
total 64K
drwxr-xr-x 2 elek elek 4.0K May 21 10:43 .
drwxr-xr-x 8 elek elek 4.0K May 21 10:43 ..
-rw-r--r-- 1 elek elek 4.6K May 21 10:43 CommandShell.md
-rw-r--r-- 1 elek elek 13K May 21 10:43 GettingStarted.md
-rw-r--r-- 1 elek elek 3.5K May 21 10:43 _index.md
-rw-r--r-- 1 elek elek 7.5K May 21 10:43 Metrics.md
-rw-r--r-- 1 elek elek 20K May 21 10:43 Rest.md
{code}
I tested it on OSX and can reproduce the problem. I think the problem is that I
did the diff without the --binary option. Could you please test the latest
version? It is exactly the same but created with git diff --binary.
> Create ozone specific inline documentation as part of the buld
> --
>
> Key: HDDS-89
> URL: https://issues.apache.org/jira/browse/HDDS-89
> Project: Hadoop Distributed Data Store
> Issue Type: Bug
> Components: Ozone Manager, SCM
>Reporter: Elek, Marton
>Assignee: Elek, Marton
>Priority: Major
> Fix For: 0.2.1
>
> Attachments: HDDS-89.002.patch, HDDS-89.003.patch
>
>
> As ozone/hdds distribution is separated from the hadoop distribution we need
> a separated documentation package. The idea is to include make the
> documentation available from the scm/ksm web pages but later it also should
> be uploaded to the hadoop site together with the release artifacts.
> This patch creates the HTML pages from the existing markdown files in the
> build process. It's an optional step, but if the documentation is available
> it will be displayed from the scm/ksm web page.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
-
To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org
[jira] [Commented] (HDDS-89) Create ozone specific inline documentation as part of the buld
[
https://issues.apache.org/jira/browse/HDDS-89?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16482791#comment-16482791
]
Anu Engineer commented on HDDS-89:
--
The generate site is still failing from me.
{noformat}
~/d/h/d/d/bin> ./generate-site.sh
Started building sites ...
Error: Error building site: No source directory found, expecting to find it at
/Users/aengineer/diskBalancer/hadoop-ozone/docs/content
/Users/aengineer/diskBalancer/hadoop-ozone/docs/dev-support/bin{noformat}
if I go the _hadoop-ozone/docs_ directory and do a *hugo serve* I get a similar
error.
{noformat}
hugo serve
Started building sites ...
Error: Error building site: No source directory found, expecting to find it at
/Users/aengineer/diskBalancer/hadoop-ozone/docs/content
{noformat}
Do we need to tell the config.toml the source files are not in the content
directory ?
> Create ozone specific inline documentation as part of the buld
> --
>
> Key: HDDS-89
> URL: https://issues.apache.org/jira/browse/HDDS-89
> Project: Hadoop Distributed Data Store
> Issue Type: Bug
> Components: Ozone Manager, SCM
>Reporter: Elek, Marton
>Assignee: Elek, Marton
>Priority: Major
> Fix For: 0.2.1
>
> Attachments: HDDS-89.002.patch
>
>
> As ozone/hdds distribution is separated from the hadoop distribution we need
> a separated documentation package. The idea is to include make the
> documentation available from the scm/ksm web pages but later it also should
> be uploaded to the hadoop site together with the release artifacts.
> This patch creates the HTML pages from the existing markdown files in the
> build process. It's an optional step, but if the documentation is available
> it will be displayed from the scm/ksm web page.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
-
To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org
[jira] [Commented] (HDDS-89) Create ozone specific inline documentation as part of the buld
[
https://issues.apache.org/jira/browse/HDDS-89?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16482572#comment-16482572
]
genericqa commented on HDDS-89:
---
| (x) *{color:red}-1 overall{color}* |
\\
\\
|| Vote || Subsystem || Runtime || Comment ||
| {color:blue}0{color} | {color:blue} reexec {color} | {color:blue} 0m
17s{color} | {color:blue} Docker mode activated. {color} |
|| || || || {color:brown} Prechecks {color} ||
| {color:green}+1{color} | {color:green} @author {color} | {color:green} 0m
0s{color} | {color:green} The patch does not contain any @author tags. {color} |
| {color:red}-1{color} | {color:red} test4tests {color} | {color:red} 0m
0s{color} | {color:red} The patch doesn't appear to include any new or modified
tests. Please justify why no new tests are needed for this patch. Also please
list what manual steps were performed to verify this patch. {color} |
|| || || || {color:brown} trunk Compile Tests {color} ||
| {color:blue}0{color} | {color:blue} mvndep {color} | {color:blue} 1m
13s{color} | {color:blue} Maven dependency ordering for branch {color} |
| {color:green}+1{color} | {color:green} mvninstall {color} | {color:green} 27m
5s{color} | {color:green} trunk passed {color} |
| {color:green}+1{color} | {color:green} compile {color} | {color:green} 32m
11s{color} | {color:green} trunk passed {color} |
| {color:green}+1{color} | {color:green} mvnsite {color} | {color:green} 21m
43s{color} | {color:green} trunk passed {color} |
| {color:green}+1{color} | {color:green} shadedclient {color} | {color:green}
10m 35s{color} | {color:green} branch has no errors when building and testing
our client artifacts. {color} |
| {color:green}+1{color} | {color:green} javadoc {color} | {color:green} 6m
47s{color} | {color:green} trunk passed {color} |
|| || || || {color:brown} Patch Compile Tests {color} ||
| {color:blue}0{color} | {color:blue} mvndep {color} | {color:blue} 0m
26s{color} | {color:blue} Maven dependency ordering for patch {color} |
| {color:red}-1{color} | {color:red} mvninstall {color} | {color:red} 1m
7s{color} | {color:red} hadoop-ozone in the patch failed. {color} |
| {color:red}-1{color} | {color:red} mvninstall {color} | {color:red} 27m
25s{color} | {color:red} root in the patch failed. {color} |
| {color:red}-1{color} | {color:red} mvninstall {color} | {color:red} 0m
20s{color} | {color:red} hadoop-dist in the patch failed. {color} |
| {color:red}-1{color} | {color:red} mvninstall {color} | {color:red} 0m
22s{color} | {color:red} docs in the patch failed. {color} |
| {color:red}-1{color} | {color:red} compile {color} | {color:red} 35m
16s{color} | {color:red} root in the patch failed. {color} |
| {color:red}-1{color} | {color:red} javac {color} | {color:red} 35m 16s{color}
| {color:red} root in the patch failed. {color} |
| {color:red}-1{color} | {color:red} mvnsite {color} | {color:red} 3m
0s{color} | {color:red} root in the patch failed. {color} |
| {color:red}-1{color} | {color:red} shellcheck {color} | {color:red} 0m
2s{color} | {color:red} The patch generated 3 new + 0 unchanged - 0 fixed = 3
total (was 0) {color} |
| {color:orange}-0{color} | {color:orange} shelldocs {color} | {color:orange}
0m 22s{color} | {color:orange} The patch generated 286 new + 114 unchanged - 0
fixed = 400 total (was 114) {color} |
| {color:green}+1{color} | {color:green} whitespace {color} | {color:green} 0m
0s{color} | {color:green} The patch has no whitespace issues. {color} |
| {color:green}+1{color} | {color:green} xml {color} | {color:green} 0m
5s{color} | {color:green} The patch has no ill-formed XML file. {color} |
| {color:green}+1{color} | {color:green} shadedclient {color} | {color:green}
10m 28s{color} | {color:green} patch has no errors when building and testing
our client artifacts. {color} |
| {color:red}-1{color} | {color:red} javadoc {color} | {color:red} 6m
51s{color} | {color:red} root in the patch failed. {color} |
|| || || || {color:brown} Other Tests {color} ||
| {color:red}-1{color} | {color:red} unit {color} | {color:red}156m 59s{color}
| {color:red} root in the patch failed. {color} |
| {color:red}-1{color} | {color:red} asflicense {color} | {color:red} 1m
19s{color} | {color:red} The patch generated 10 ASF License warnings. {color} |
| {color:black}{color} | {color:black} {color} | {color:black}346m 24s{color} |
{color:black} {color} |
\\
\\
|| Reason || Tests ||
| Failed junit tests | hadoop.hdfs.TestReadStripedFileWithMissingBlocks |
| | hadoop.hdfs.security.TestDelegationTokenForProxyUser |
| | hadoop.hdfs.server.namenode.ha.TestEditLogTailer |
| | hadoop.hdfs.server.balancer.TestBalancerRPCDelay |
| | hadoop.hdfs.server.datanode.TestDirectoryScanner |
| | hadoop.hdfs.client.impl.TestBlockReaderLocal |
| | hadoop.hdfs.server.datanode.TestDataNodeVolumeFailure |
\\
\\
|| Subsystem || Report/Notes ||
| Docker | Client=17.05.0-ce Server=17.05.0-ce
[jira] [Commented] (HDDS-89) Create ozone specific inline documentation as part of the buld
[
https://issues.apache.org/jira/browse/HDDS-89?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16482313#comment-16482313
]
Elek, Marton commented on HDDS-89:
--
Thanks the feedback [~anu] a lot. I just upload a new patch with the fixes (and
deleted the old one to not confuse jenkins).
3: I found that a dependency was missing between hadoop-ozone-docs ->
hadoop-dist, therefore the documentation is generated after the hadoop-dist
step. I didn't notice it as I already had the generated site. Now I fixed it
with adding hadoop-ozone-docs as a dependency in hadooop-dist
1,2: I don't know what was the problem, may be I generated the patch in a wrong
way. Now it should be ok:
{code}
diff --git a/hadoop-ozone/docs/dev-support/bin/generate-site.sh
b/hadoop-ozone/docs/dev-support/bin/generate-site.sh
new file mode 100755
index 000..3323935a743
--- /dev/null
+++ b/hadoop-ozone/docs/dev-support/bin/generate-site.s
{code}
> Create ozone specific inline documentation as part of the buld
> --
>
> Key: HDDS-89
> URL: https://issues.apache.org/jira/browse/HDDS-89
> Project: Hadoop Distributed Data Store
> Issue Type: Bug
> Components: Ozone Manager, SCM
>Reporter: Elek, Marton
>Assignee: Elek, Marton
>Priority: Major
> Fix For: 0.2.1
>
> Attachments: HDDS-89.002.patch
>
>
> As ozone/hdds distribution is separated from the hadoop distribution we need
> a separated documentation package. The idea is to include make the
> documentation available from the scm/ksm web pages but later it also should
> be uploaded to the hadoop site together with the release artifacts.
> This patch creates the HTML pages from the existing markdown files in the
> build process. It's an optional step, but if the documentation is available
> it will be displayed from the scm/ksm web page.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
-
To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org
[jira] [Commented] (HDDS-89) Create ozone specific inline documentation as part of the buld
[
https://issues.apache.org/jira/browse/HDDS-89?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16481083#comment-16481083
]
Anu Engineer commented on HDDS-89:
--
[~elek] Thanks for the patch. Here are some comments.
# [ERROR] Failed to execute goal
org.codehaus.mojo:exec-maven-plugin:1.6.0:exec (default) on project
hadoop-ozone-docs: Command execution failed. Cannot run program
"dev-support/bin/generate-site.sh" (in directory
"/Users/aengineer/diskBalancer/hadoop-ozone/docs"): error=13, Permission denied
-> [Help 1]
# had to fix it with ~/d/h/d/d/bin> chmod +x generate-site.sh
# if I run
{noformat}
cd ./hadoop-dist/target/compose/ozone
docker-compose up
{noformat}
followed by [http://localhost:9874|http://localhost:9874/] I am not able to see
the docs link.
What am I doing wrong?
> Create ozone specific inline documentation as part of the buld
> --
>
> Key: HDDS-89
> URL: https://issues.apache.org/jira/browse/HDDS-89
> Project: Hadoop Distributed Data Store
> Issue Type: Bug
> Components: Ozone Manager, SCM
>Reporter: Elek, Marton
>Assignee: Elek, Marton
>Priority: Major
> Fix For: 0.2.1
>
> Attachments: HDDS-89-HDDS-48.001.patch
>
>
> As ozone/hdds distribution is separated from the hadoop distribution we need
> a separated documentation package. The idea is to include make the
> documentation available from the scm/ksm web pages but later it also should
> be uploaded to the hadoop site together with the release artifacts.
> This patch creates the HTML pages from the existing markdown files in the
> build process. It's an optional step, but if the documentation is available
> it will be displayed from the scm/ksm web page.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
-
To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org
[jira] [Commented] (HDDS-89) Create ozone specific inline documentation as part of the buld
[ https://issues.apache.org/jira/browse/HDDS-89?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16480525#comment-16480525 ] Elek, Marton commented on HDDS-89: -- No new documentation here just the modification of the build process + a very simple theme to display the rendered documentation. The theme could be replaced/improved later, in the current form we don't need to add anything to the license/notice files as bootstrap/jquery/glyphicons are already used and handled. To test, put hugo to your PATH and do a full build. After starting scm/ksm you can see a new documentation menu with the existing content. > Create ozone specific inline documentation as part of the buld > -- > > Key: HDDS-89 > URL: https://issues.apache.org/jira/browse/HDDS-89 > Project: Hadoop Distributed Data Store > Issue Type: Bug > Components: Ozone Manager, SCM >Reporter: Elek, Marton >Assignee: Elek, Marton >Priority: Major > Fix For: Acadia > > Attachments: HDDS-89-HDDS-48.001.patch > > > As ozone/hdds distribution is separated from the hadoop distribution we need > a separated documentation package. The idea is to include make the > documentation available from the scm/ksm web pages but later it also should > be uploaded to the hadoop site together with the release artifacts. > This patch creates the HTML pages from the existing markdown files in the > build process. It's an optional step, but if the documentation is available > it will be displayed from the scm/ksm web page. -- This message was sent by Atlassian JIRA (v7.6.3#76005) - To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org
