Comments (16)
@jmerlan should the documentation be in the Code section instead of the Wiki? The repository represents the website, and if the pages were treated as code it could be forked to support creating variants. Forking does not bring over Wikis.
from openrfa-website.
I feel like it should be a wiki unless the code is executed/viewed on another platform. Thoughts?
from openrfa-website.
GitHub supports the idea of using Repos for website content: https://pages.github.com/
from openrfa-website.
https://lab.github.com/courses/introduction-to-html
from openrfa-website.
In terms of your comment about "executed/viewed on another platform", I see what you're saying. I still would like to see if we can have GitHub be the backend and OpenRFA.org be the front end for the typical user. I feel like linking from openrfa.org to github.com would be confusing for most casual users.
Could we have a html file in github, host it from github, then iframe it into openrfa.org?
from openrfa-website.
There are a few ways to accomplish what we are discussing here. I would still like to use some form of a CMS if possible though as it would save a lot of time from having to create templates from scratch.
We can actually have a full static HTML page as a Drupal node with no theming: https://www.drupal.org/project/static_page
from openrfa-website.
How about using markdown in github? it would be limited but I don’t think the docs have anything markdown couldn’t already handle, no? It would complicate Drupal displaying it, but maybe a module like this could be employed?
https://www.drupal.org/project/markdown
from openrfa-website.
If we store the content only (no wrappers or templates) as plain text using markdown here on GitHub, this could actually work. I like it.
We would just need to figure out how to display the body from GitHub on our Drupal site. Shouldn't be hard, but might take a custom module.
from openrfa-website.
Ok, this is brilliant. I went ahead and created a test HTML file and with the simple PHP snippet below was able to pull the raw HTML directly from the GitHub repo. I think this is going to work! I will test an HTML file using markdown tomorrow.
<?php include("https://raw.githubusercontent.com/OpenDBO/OpenRFA/master/WebApp/Documentation/Process/LifeCycle.html"); ?>
from openrfa-website.
Fantastic! I’ll look tomorrow.
from openrfa-website.
The test for the markdown is successful! Check it out the live MD from this GitHub repo being displayed as content here: http://openrfa.org/documentation/life-cycle-parameter
I am going to close this issue and create a separate issue for each documentation page.
from openrfa-website.
Did you test the flow chart image? Also, looks like it is not pulling in the bulleted list correctly.
from openrfa-website.
Hmm, specifically:
"Moderators will review the parameter against the follow criteria: - Follows the standard naming convention - Is not a duplicate (or similar) parameter to an "Approved" parameter - Is assigned the proper DATA TYPE - Contains a DESCRIPTION. A moderator may modify the parameter to ensure compliance with these standards."
The lower bulleted list works.
Let's iron this out completely before we move to the rest of the pages.
from openrfa-website.
This is so cool (using github backend). So it appears the bulleted list is fixed now and I found a typo. Not sure why but the bulleted list did not work without a carriage return above it. Line 18 fixed it.
Check out 9c7dc70
from openrfa-website.
I left the flowchart off as I was considering converting to SVG so that it is editable in the event of a fork. Thoughts?
from openrfa-website.
Good idea on the SVG however I'd recommend adding the image for now and treat the SVG as an enhancement.
from openrfa-website.
Related Issues (20)
- Fork RevitLookup for OpenRFA features HOT 1
- COBie Mapping Table reorganization
- COBie Attribute v2.4 versioning HOT 2
- Finish GitHub community profile checklist
- Add icon to OSAIC org profile
- OpenRFA collaboration vision and framework HOT 3
- Zulip integration for GitHub HOT 1
- Zulip SSO HOT 1
- Zulip: one for OSAIC or one per community HOT 3
- OpenRFA SSO account linking/merging HOT 1
- Add license information to OpenRFA.org website HOT 2
- Create a Zulip bot to post messages from Zulip to OpenRFA.org HOT 2
- Add landing page to repo
- Display messages from Discuss.OpenAIM.io topic on shared parameter page HOT 2
- Fix image sources on static pages
- Drupal rule sends "approved" Zulip message when parameter is edited
- Use hierarchical_select module for data definitions
- Use Organic Groups for parameter permissions
- New node type for "personal" parameters
- Implement a weekly email digest newsletter
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from openrfa-website.