Code Monkey home page Code Monkey logo

Comments (8)

alexwelch avatar alexwelch commented on August 24, 2024

Thanks @Xe - you wanna just make a PR to the UI project with a .md file, that way it get's in our hopper and we can add to the wiki manually (we'll give you street cred). Unfortunately we don't have a formalized way of making wiki contributions yet... We certainly welcome and appreciate any feedback on the wiki.

from panamax-ui.

Xe avatar Xe commented on August 24, 2024

My .md file depends on the cloud config and the provision script. How should I include those files? Other projects like Deis have a contrib folder where stuff like this can go.

from panamax-ui.

alexwelch avatar alexwelch commented on August 24, 2024

@Xe - interesting... I've been talking with the team about adding a contrib directory to panamax-coreos, like you have in deis. Have you all had any issues with that model? I guess the other model would be to let people create and maintain separate repos for each directory that we'd have in contrib, that way they don't have to depend on use to merge... In this specific case it seems silly to have wiki instructions that manage a non-panamax repo... P.S. I'm going to make the wiki editable by all right now, doing PRs on that thing is virtually impossible... Thanks!

from panamax-ui.

Xe avatar Xe commented on August 24, 2024

We haven't had any major issues with it. It's not the best place in the world to put that documentation but it seems to be the least bad from what I've seen. Other projects I know of use a contrib submodule, but git submodules can also add undue complexity. Maybe this might be best handled as a contrib "wiki" made up of a folder of markdown documents sorted by the kind? If you like I could get started on making such a "wiki" based on the existing contents later after I get off work.

from panamax-ui.

alexwelch avatar alexwelch commented on August 24, 2024

Alright, so we've been kicking this around a bit today... We are still trying to decide on the "deployment" mechanism for panamax as there are potential security issues, etc. with deploying panamax to a cloud right now. See: https://github.com/CenturyLinkLabs/panamax-ui/wiki/Installing-Panamax#cloud-provider-installation

On the flip side we have had a large number of people install panamax in the cloud and do not want to keep folks from doing so, as long as they understand the security risks... All that said, we'd love your contribution to the Wiki (could probably go under that link I sent above). How do you feel about keeping the code in your repository for now? The other thing we could do is create a repo just for those extensions and let you push to that, if you'd prefer... I think eventually we'll have a better facility for this, it's just too soon to even know where to put that "contrib" folder, or the like.

What do you think?

from panamax-ui.

Xe avatar Xe commented on August 24, 2024

After thinking a bit, I think that it might be best to make a separate pamanax-contrib repository and have that store the instructions for provisioning on various cloud platforms. One folder per platform like the Deis contrib folder.

I can submit my changes to the wiki as they are (linking to my dotfiles repo ofc), but making a separate repo for the provision scripts and the like would probably be ideal as things get more complicated over time. It would also have the advantage of being "semi-branded" and not just "oh hey run this script from this 5th level subfolder in this guy's dotfiles repo".

Know what I mean?

from panamax-ui.

alexwelch avatar alexwelch commented on August 24, 2024

yeah, I think that is a good idea. I created a repo here: https://github.com/CenturyLinkLabs/panamax-contrib if you wanna move your PR

from panamax-ui.

Xe avatar Xe commented on August 24, 2024

Thanks much!

from panamax-ui.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.