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

Fixes #358 Allow user to specify branch to generate docs #424

Merged
merged 1 commit into from Aug 27, 2017

Conversation

4 participants
@imujjwal96
Copy link
Contributor

imujjwal96 commented Aug 24, 2017

Description

Allow users to specify branches from their registered repositories settings at Yaydoc. User may also delete some of the specified branches.
If no branches are specified, documentation will be generated from all branches containing .yaydoc.yml file, except the gh-pages branch

Related Issue

Fixes #358

Motivation and Context

The documentation for a registered repository is generated at every commit made to the repository. This process happens in commits made to any of the repository's branches except for branches that do not have a .yaydoc.yml file and the gh-pages branch. It would be nice if the user can limit the doc generation process to a specific branch or a couple of branches

How Has This Been Tested?

Test at https://yaydoc7.herokuapp.com

Types of changes

  • Bug fix
  • New feature

Checklist:

  • I have read the Contribution & Best practices Guide and my PR follows them.
  • There is a corresponding issue for this pull request.
  • Mentioned the Issue number in the pull request commit message Fixes #<number> commit message
  • There is only one commit per issue.

@imujjwal96 imujjwal96 added the WIP label Aug 24, 2017

@imujjwal96 imujjwal96 force-pushed the imujjwal96:issue358 branch 4 times, most recently from 95213c8 to b611aeb Aug 24, 2017

@imujjwal96 imujjwal96 removed the WIP label Aug 25, 2017

@imujjwal96 imujjwal96 self-assigned this Aug 25, 2017

@imujjwal96 imujjwal96 requested review from sch00lb0y and pri22296 Aug 25, 2017

@imujjwal96 imujjwal96 force-pushed the imujjwal96:issue358 branch from b611aeb to 3174648 Aug 25, 2017

@imujjwal96

This comment has been minimized.

Copy link
Contributor

imujjwal96 commented Aug 25, 2017

@pri22296 @sch00lb0y Please review.

@@ -1,10 +1,9 @@
$(function() {
const predefinedMessages = {
'mail_disabled_successful': "Mail service disabled for this repository",

This comment has been minimized.

@pri22296

pri22296 Aug 26, 2017

Member

Are these messages no longer needed?

This comment has been minimized.

@imujjwal96

imujjwal96 Aug 26, 2017

Contributor

No we are not showing them now. We have added a toggle for these events and we show a check mark beside the element when the change is successful

@pri22296

This comment has been minimized.

Copy link
Member

pri22296 commented Aug 26, 2017

@imujjwal96 Shows null after adding and deleting branches

screenshot 218

@imujjwal96

This comment has been minimized.

Copy link
Contributor

imujjwal96 commented Aug 26, 2017

@pri22296 I am not able to reproduce this error

@pri22296

This comment has been minimized.

Copy link
Member

pri22296 commented Aug 26, 2017

@imujjwal96 Let me test this more and i'll get back to you If I can reproduce it.

@pri22296

This comment has been minimized.

Copy link
Member

pri22296 commented Aug 26, 2017

@imujjwal96 I'm not able to reproduce that error. It wold be great though if you could take a look at the code and just ensure that everything is fine.

Also submit button gets hidden when there are >=3 branches.
screenshot 219

@imujjwal96

This comment has been minimized.

Copy link
Contributor

imujjwal96 commented Aug 26, 2017

Also submit button gets hidden when there are >=3 branches.
does it create any problem? I thought users may not submit the form without closing the select tag

@pri22296

This comment has been minimized.

Copy link
Member

pri22296 commented Aug 26, 2017

The UI feels awkward there. consider showing the branches with a scroll bar and having the submit button slightly below.

@imujjwal96 imujjwal96 force-pushed the imujjwal96:issue358 branch from 3174648 to 42a1078 Aug 26, 2017

@imujjwal96

This comment has been minimized.

Copy link
Contributor

imujjwal96 commented Aug 26, 2017

@pri22296 Updated it.

@fossasia-bot fossasia-bot bot removed the needs-review label Aug 26, 2017

}, function (error, response, body) {
if (error) {
callback(error);

This comment has been minimized.

@sch00lb0y

sch00lb0y Aug 27, 2017

Contributor

pass null in the second parameter. it look consistent

@imujjwal96 imujjwal96 force-pushed the imujjwal96:issue358 branch from 42a1078 to ec441d4 Aug 27, 2017

@imujjwal96

This comment has been minimized.

Copy link
Contributor

imujjwal96 commented Aug 27, 2017

@mariobehling mariobehling merged commit f2b0817 into fossasia:master Aug 27, 2017

2 checks passed

codacy/pr Good work! A positive pull request.
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment