Skip to content
This repository was archived by the owner on Nov 17, 2023. It is now read-only.

fix website build #14148

Merged
szha merged 2 commits into from
Feb 14, 2019
Merged

fix website build #14148

szha merged 2 commits into from
Feb 14, 2019

Conversation

@szha
Copy link
Member

@szha szha commented Feb 13, 2019 •
edited
Loading

Description

fix website build caused by #14142

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

Changes

  • fix license (comment) formatting to be compatible with website build tools.

@szha szha requested a review from iblislin as a code owner February 13, 2019 20:48
szha
szha commented Feb 13, 2019
View reviewed changes
example/gluon/lipnet/README.md
@@ -1,3 +1,22 @@
<!---
Copy link
Member Author

@szha szha Feb 13, 2019

Choose a reason for hiding this comment

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

This was missed from #13647 even though I made the comment on the PR about the same (see #13647 (comment))

@ankkhedia
Copy link
Contributor

ankkhedia commented Feb 13, 2019

@szha Thanks for your contribution!

@mxnet-label-bot add [pr-work-in-progress, website, build]

@marcoabreu marcoabreu added Build pr-work-in-progress PR is still work in progress Website labels Feb 13, 2019
aaronmarkham
aaronmarkham suggested changes Feb 13, 2019
View reviewed changes
Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

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

This comment style seems to be incompatible with the docs tool chain.
I tried this style and it works:

[//]: #  (Licensed to the Apache Software Foundation under one)

Note I had to get rid of the (ASF) as I couldn't figure out how to escape the parenthesis. 🤷‍♂️
If the RAT script looks for the specific string, then, well, I guess we still have a problem, but now in a different spot.
You could just add another option for the rat check to check.

@aaronmarkham
Copy link
Contributor

aaronmarkham commented Feb 13, 2019

My suggestion comes from this discussion on markdown comments: https://stackoverflow.com/questions/4823468/comments-in-markdown

@aaronmarkham
Copy link
Contributor

aaronmarkham commented Feb 13, 2019

Try this instead:


<!---Licensed to the Apache Software Foundation (ASF) under one-->
<!---  or more contributor license agreements.  See the NOTICE file-->
<!---  distributed with this work for additional information-->
<!---  regarding copyright ownership.  The ASF licenses this file-->
<!---  to you under the Apache License, Version 2.0 (the-->
<!---  "License"); you may not use this file except in compliance-->
<!---  with the License.  You may obtain a copy of the License at-->

<!---    http://www.apache.org/licenses/LICENSE-2.0-->

<!---  Unless required by applicable law or agreed to in writing,-->
<!---  software distributed under the License is distributed on an-->
<!---  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
<!---  KIND, either express or implied.  See the License for the-->
<!---  specific language governing permissions and limitations-->
<!---  under the License.-->

I have it working here: http://34.201.8.176/versions/fix_web/api/clojure/index.html

@szha
Copy link
Member Author

szha commented Feb 13, 2019

@aaronmarkham that worked. http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-14148/6/faq/index.html

lanking520
lanking520 approved these changes Feb 13, 2019
View reviewed changes
Copy link
Member

@lanking520 lanking520 left a comment

Choose a reason for hiding this comment

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

It passed the test and seemed to be rendering fine. LGTM

@szha szha changed the title [WIP] fix website build fix website build Feb 14, 2019
@szha szha merged commit 6f9a679 into apache:master Feb 14, 2019
@szha szha deleted the fix_web branch February 14, 2019 00:24
szha added a commit to szha/mxnet that referenced this pull request Feb 14, 2019
@szha
fix website build (apache#14148)
8d537f4 
* fix rendering of markdown doc

* fix missing license from lipnet example
@szha szha mentioned this pull request Feb 14, 2019
Merged
7 tasks
szha added a commit to szha/mxnet that referenced this pull request Feb 14, 2019
@szha
fix website build (apache#14148)
2c6a3fe 
* fix rendering of markdown doc

* fix missing license from lipnet example
szha added a commit that referenced this pull request Feb 14, 2019
@szha
V1.4.x RAT check fix (#14156)
4c7fc7f 
* make rat-excludes compliant with apache release policy (#14142)

* remove md from whitelist

* remove rst from whitelist

* remove docker folder from whitelist

* remove docs from whitelist

* fix website build (#14148)

* fix rendering of markdown doc

* fix missing license from lipnet example

* fix diff
stephenrawls pushed a commit to stephenrawls/incubator-mxnet that referenced this pull request Feb 16, 2019
@szha @stephenrawls
fix website build (apache#14148)
1035010 
* fix rendering of markdown doc

* fix missing license from lipnet example
lanking520 pushed a commit to lanking520/incubator-mxnet that referenced this pull request Feb 18, 2019
@szha @lanking520
V1.4.x RAT check fix (apache#14156)
0cac767 
* make rat-excludes compliant with apache release policy (apache#14142)

* remove md from whitelist

* remove rst from whitelist

* remove docker folder from whitelist

* remove docs from whitelist

* fix website build (apache#14148)

* fix rendering of markdown doc

* fix missing license from lipnet example

* fix diff
drivanov pushed a commit to drivanov/incubator-mxnet that referenced this pull request Mar 4, 2019
@szha @drivanov
fix website build (apache#14148)
c40c385 
* fix rendering of markdown doc

* fix missing license from lipnet example
vdantu pushed a commit to vdantu/incubator-mxnet that referenced this pull request Mar 31, 2019
@szha @vdantu
fix website build (apache#14148)
7997cb1 
* fix rendering of markdown doc

* fix missing license from lipnet example
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
@szha
fix website build (apache#14148)
8d80888 
* fix rendering of markdown doc

* fix missing license from lipnet example
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@iblislin iblislin Awaiting requested review from iblislin

@gigasquid gigasquid Awaiting requested review from gigasquid gigasquid is a code owner

@nswamy nswamy Awaiting requested review from nswamy nswamy is a code owner

@sergeykolychev sergeykolychev Awaiting requested review from sergeykolychev sergeykolychev is a code owner

@yzhliu yzhliu Awaiting requested review from yzhliu yzhliu is a code owner

3 more reviewers

@aaronmarkham aaronmarkham aaronmarkham approved these changes

@piyushghai piyushghai piyushghai approved these changes

@lanking520 lanking520 lanking520 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Build pr-work-in-progress PR is still work in progress Website

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@szha @ankkhedia @aaronmarkham @piyushghai @lanking520 @marcoabreu