Giter VIP home page Giter VIP logo

atlassianps.github.io's Introduction

AtlassianPS

atlassianps.github.io's People

Contributors

brianbunke avatar ebekker avatar lawrence-w avatar lipkau avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

atlassianps.github.io's Issues

Smooth Scrolling Plugin seems broke some external URLs with #

Expectation

Go to webpage https://atlassianps.org/docs/Contributing/
and click on Homepage link under thank you quoted message

Status Quo

I am expecting to be redirected to https://atlassianps.org/#people, however the link is not working on chrome and edge browsers

My suggestion

$('a[href*="#"]:not([href="#"]), a.inpage-navigation[href*="#"]').on('click', function (event) { event.preventDefault(); smoothScroll($(this.hash)); });

change to
$('a[href^="#"]:not([href="#"]), a.inpage-navigation[href*="#"]').on('click', function (event) { event.preventDefault(); smoothScroll($(this.hash)); });

in the theme.js file, as I bet smooth scroll broke such URLs

Sync submodules

git submodule foreach git pull origin master
git add modules/ConfluencePS
git commit -m "Update module ConfluencePS"
git push

module pages

Description

Each module should have it's own page using layout _layouts/module.html

Should this be about_ModuleName?
Should this be readme?

EU Cookie

Description

There is a EU Regulation that requires homepages to "inform users that cookies are not being used to gather information unnecessarily"

slack page

Description

User should be able to get a slack invite from the homepage

docs page

Description

Documentation pages should have their own layout

ToDo

  • create _layouts/docs.html
    • should have own sidebar with scrollspy
    • should have additional nav bar to explore commands
    • should have a way to navigate in the docs across modules and common docs
    • should use about_ModuleName as index

Structure

Ideal structure

/docs
  /HowToContribute.md
  /BitbucketPS
    /about_BitbucketPS.md
    /Get-Branch.md
  /ConfluencePS
    /about_ConfluencePS.md
    /Get-Space.md

Is it possible to expose this structure by storing the submodules in _includes/?

api.atlassianps.org

Description

Have a way to register persistent data

Use Case

  • Cache github data
  • Register errors

ToDo

  • register subdomain api
  • serve a Laravel instance on subdomain
  • create rest interface for cache
  • create rest interface for error logging

Add metadata of github

  • show the count of current open issues of repo
  • link to issues overview instead of new issue

Add People

find all contributors and add them to _data/index/people.yml

TOC if docs must be smarter

  • The right navigation of the docs , the toc, currently shows only h2 headers
    However, on the index of modules (about_*) the h1 tag would be more appropriate
  • The TOC sidebar should allow ScrollSpy

Improved article/help header

It would be nice to have a header with some extra metadata visualized for an article.

Expectation

A bit like docs.microsoft.com
image
Where you can see the contributors and maybe even a "time to read" for articles/posts.

Status Quo

Now we don't have the contributors nor the "time to read"

My suggestion

Use a contributors yml field in the .md files like contributors: lipkau, tomasdeceuninck

fix href

frontpage still contains links that are not point to the correct location

contact page

Description

Contact page should include information on how the user can create issues or reach the organization

post page

Description

Organization should be able to write posts

Fix styling

  • homepage uses a mix of font-families : harmonize
  • fix styling of buttons on landing page
  • make logo a working link and make it navy blue

Footer

all pages need a footer

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.