Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Users guide devo #22

Merged
merged 35 commits into from
Jul 25, 2019
Merged

Users guide devo #22

merged 35 commits into from
Jul 25, 2019

Conversation

bradlaufenberg
Copy link
Contributor

No description provided.

@bradlaufenberg bradlaufenberg mentioned this pull request Jul 23, 2019
Closed
@gonuke
Copy link
Member

gonuke commented Jul 23, 2019

This should not include any of the files in gh-build. Only files in the doc directory.

@bradlaufenberg
Copy link
Contributor Author

I deleted all of the gh-build files. I will be opening up a new PR with the other parts of the documentation since this one is already pretty large. So let me know if there is anything else that needs to be done on the user's guide. One thing I noticed is that the glossary terms were not filled out on the original website, (this might be a project for another time?).

@gonuke
Copy link
Member

gonuke commented Jul 23, 2019

There is still something a little strange about this PR. It seems to be repeating some of the changes that were already merged. Perhaps @bam241 or @zxkjack123 can help you rebase against the master branch to clean this up.

Also - there appear to be some HTML files as part of this PR that should not be. This PR should only include RST files.

@bradlaufenberg
Copy link
Contributor Author

I will be sure to ask one of them for help tomorrow. As far as the HTML files showing up, this is because I created a directory within the doc directory for specifically the user's guide and moved all of the original HTML files into it, (I did this to copy the organization of the DAGMC documentation). So I'm fairly certain the only thing changed about them is their location and indicating this change is why they are a part of the PR. Will also look into this further tomorrow.

@gonuke
Copy link
Member

gonuke commented Jul 23, 2019

I understand now the HTML file thing... that's fine. But we do want to clarify the other stuff.

@bam241
Copy link
Member

bam241 commented Jul 23, 2019

@bradlaufenberg feel free to ping me if you need help !

Brad Laufenberg added 22 commits July 23, 2019 12:11
Created a restructured text format for the credits page in the Users'…
109c97f 
… guide.
Created a restructed text format for the introduction page of the Use…
ed52b42 
…rs' guide.
Created a restructed text format for the support file description pag…
a492ee3 
…e of the Users' guide.
Created a restructured text file for the Manual Syntax page of the us…
a014c29 
…ers' guide
Updated style by forcing ~60 character hard line wraps
fed1f7f
Updated style by forcing ~60 character hard line wraps
043155f
Updated style by forcing ~60 character hard line wraps
bd32e70
Updated style by forcing ~60 character hard line wraps
aa02cc5
Added links to get to the webpage's glossary
5c46cc7
Added links to get to the webpage's glossary
a899f8d
Reformated the command line options page into an rst file
855b763
Edited the glossary links
53a3a45
Created the glossary as an rst file
8d515d6
Reformated the Output file page of the Users' guide into an rst file
c2932cc
Added internal reference links to navigate the file easier
392afac
Added internal and external hyperlinks to help navigate the users' guide
d6fc39d
Added internal and external hyperlinks to help navigate the users' guide
b8f3b3d
Added external hyperlinks to help navigate the users' guide
c1ef666
Added internal links to make navigating the error page easier
12c33ea
Edited table, had bad formatting
fefc7d4
Created an rst file for the input page of the users' guide
a0cab9a
Created a directory to store all users' guide files within the doc di…
2ca8f28 
…rectory
Brad Laufenberg added 11 commits July 23, 2019 12:11
Temporary change of source branch in order to run build tests
f5bed11
Added introduction paragraph and toctree to websites main index page
90b1a64
Moved all users' guide files to its own directory within the doc dire…
d7017d4 
…ctory
Made small changes to users' guide documents in order to allow sphinx…
4368ac6 
… to interperet it
Continuing to edit my original atempt at the users' guide to make sph…
730a810 
…inx be able to interperet it
Further updating rst format to allow sphinx to build website
34b9728
First successful compling of the users guide as an html using the mak…
2c2705d 
…e file, then referenced the build to make formatting more aesthetic and easier to use
Continued to further improve the website ny proofreading the users' g…
4cb74d6 
…uide gh-build as html
The final edits to the rst files of the users' guide, tested with the…
f7883d8 
… makefile and proofread
Changed the makefile back to building off of the master branch
b358618
Deleted all gh-build files
d83271b
@bradlaufenberg
Copy link
Contributor Author

@bam241 was able to help me rebase and we resolved the changes that were being repeated.

gonuke
gonuke requested changes Jul 23, 2019
View reviewed changes
Copy link
Member

@gonuke gonuke left a comment

Choose a reason for hiding this comment

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

(at least) one of the HTML files has a typo in the file extension

I think this is a good first pass and the users guide. I expect we'll have opportunities to update and improve the text that is here, but that's not the point of this first PR.

@bradlaufenberg
Copy link
Contributor Author

I found one typo in the HTML file extensions and changed it, the rest looked good to me. Let me know if there is anything else needed to be done.

@gonuke
Copy link
Member

gonuke commented Jul 25, 2019

Thanks @bradlaufenberg - this is a great starting point and we can do more edits from here

@gonuke gonuke merged commit 4f3eb95 into svalinn:master Jul 25, 2019
@bradlaufenberg bradlaufenberg deleted the users_guide_devo branch July 29, 2019 18:17
@ljacobson64 ljacobson64 mentioned this pull request Oct 11, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gonuke gonuke gonuke approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@bradlaufenberg @gonuke @bam241