Skip to content

Commit

Permalink
Changes to the structure (#32)
Browse files Browse the repository at this point in the history
* Create work.md

adding a section for work 

Signed-off-by: Amnesty AM <[email protected]>

* Create contributing.md

Signed-off-by: Amnesty AM <[email protected]>

* Create code-of-conduct.md

Signed-off-by: Amnesty AM <[email protected]>

* Create credits.md

Signed-off-by: Amnesty AM <[email protected]>

* Update contributing.md

Signed-off-by: Amnesty AM <[email protected]>

* Update code-of-conduct.md

Signed-off-by: Amnesty AM <[email protected]>

* Update index.md

Signed-off-by: Amnesty AM <[email protected]>

* Create work.md

Signed-off-by: Amnesty AM <[email protected]>

* Update work.md

Signed-off-by: Amnesty AM <[email protected]>

* Update work.md

Signed-off-by: Amnesty AM <[email protected]>

* Update index.md

Signed-off-by: Amnesty AM <[email protected]>

* Update index.md

Signed-off-by: Amnesty AM <[email protected]>

* Create work.md

Signed-off-by: Amnesty AM <[email protected]>

* Update work.md

Signed-off-by: Amnesty AM <[email protected]>

* Update work.md

Signed-off-by: Amnesty AM <[email protected]>

* Update menu_v2.yml

Signed-off-by: Amnesty AM <[email protected]>

---------

Signed-off-by: Amnesty AM <[email protected]>
  • Loading branch information
AmnestyAM authored Nov 15, 2024
1 parent ab02d8e commit 25059d4
Show file tree
Hide file tree
Showing 10 changed files with 125 additions and 117 deletions.
9 changes: 9 additions & 0 deletions _data/menu_v2.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
AspirePress:
Introduction: '/'
Code of Conduct: '/code-of-conduct/'
Contributing: '/contributing/'
Credits: '/credits/'


AspireCloud:
Introduction: '/aspirecloud/'
Work: '/aspirecloud/work/'


AspireSync:
Introduction: '/aspiresync/'
Work: '/aspiresync/work/'


AspireUpdate:
Introduction: '/aspireupdate/'
Work: '/aspireupdate/work/'
40 changes: 0 additions & 40 deletions docs/aspirecloud/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,44 +39,4 @@ flowchart TD
### Configuration
- A complete REST API for AspireCloud including federation/defederation
- An interoperability specification with other repository projects
- Need a technical architect for working out the overall design
- Need testers!

See [AspireCloud README](https://github.com/aspirepress/AspireCloud)

## 👥 The AspireCloud Contributors

- Get feedback on proposed approach from AP community

[AspireCloud Contributors](https://github.com/aspirepress/AspireCloud/graphs/contributors)

## 🚨Issues/Concerns

- A complete REST API for AspireCloud including federation/defederation
- An interopability specification with other repository projects
- Need testers and implementers!


## ✅ Action items

- Continue to document a technical architecture

## 🔑 Key links

- Slack: See [#aspirecloud](https://app.slack.com/client/T07Q5LB7W23/C07QYT2BRQ9) for discussion

## Contributing

AspirePress welcomes contributions from people like you. We encourage you to review
our [Contribution Guidelines](https://github.com/aspirepress/.github/blob/main/CONTRIBUTING.md).

## Code of Conduct

AspirePress also implements a [Code of Conduct](https://github.com/aspirepress/.github/blob/main/CODE_OF_CONDUCT.md),
adherence to which is required by all members of the project.

## Credits

AspirePress is a community project, powered by people just like you. Thank you to
our [contributors](https://github.com/aspirepress/.github/blob/main/CREDITS.md) for their generous participation in
AspirePress.
28 changes: 28 additions & 0 deletions docs/aspirecloud/work.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: default
title: Welcome to AspireCloud
permalink: /aspirecloud/work/
---

# Work on AspireCloud

## 🚨 Help Required

- We need a complete REST API for AspireCloud including federation/defederation
- We need an interopability specification with other repository projects
- We need testers
- We need implementers
- We need technical architecture documentation
- Need a technical architect for working out the overall design

## 📝 Issues, Milestones and Dicussions

- GitHub [issues](https://github.com/aspirepress/AspireCloud/issues) for tracking bugs and new features
- GitHub [discussions](https://github.com/aspirepress/AspireCloud/discussions) for disucssions
- GitHub [milstones](https://github.com/aspirepress/AspireCloud/milestones) for tracking releases
- Slack channel [#aspirecloud](https://app.slack.com/client/T07Q5LB7W23/C07QYT2BRQ9) for discussions [sign up form](https://aspirepress.org/slack/)

## 👥 The AspireUpdate Contributors

[AspireCloud Contributors](https://github.com/aspirepress/AspireCloud/graphs/contributors)

38 changes: 0 additions & 38 deletions docs/aspiresync/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,41 +24,3 @@ NOTE: AspireSync runs in a Docker container, so make sure you have Docker instal

[See the AspireSync README for a QuickStart install.](https://github.com/aspirepress/AspireSync?tab=readme-ov-file#quick-start)

## 👥 The AspireSync Contributors

[AspireSync Contributors](https://github.com/aspirepress/AspireSync/graphs/contributors)

## FAQs

## 🚨Issues/Concerns

- Need testers!

## 📝 Upcoming topics

- Get feedback on functionality from AspirePress community

## ✅ Action items

- Continue to document a technical architecture
- Divide labour and create projects and tasks and milestones @Yosef Eliezrie

## 🔑 Key links

- Slack: See [#aspiresync](https://aspirepress.slack.com/archives/C07QG6AUN4E) for discussion

## Contributing

AspirePress welcomes contributions from people like you. We encourage you to review
our [Contribution Guidelines](https://github.com/aspirepress/.github/blob/main/CONTRIBUTING.md).

## Code of Conduct

AspirePress also implements a [Code of Conduct](https://github.com/aspirepress/.github/blob/main/CODE_OF_CONDUCT.md),
adherence to which is required by all members of the project.

## Credits

AspirePress is a community project, powered by people just like you. Thank you to
our [contributors](https://github.com/aspirepress/.github/blob/main/CREDITS.md) for their generous participation in
AspirePress.
25 changes: 25 additions & 0 deletions docs/aspiresync/work.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
layout: default
title: Welcome to AspireSync
permalink: /aspiresync/work/
---



## 🚨 Help Required

- We need testers

## 📝 Issues, Milestones and Dicussions

- GitHub [issues](https://github.com/aspirepress/AspireSync/issues) for tracking bugs and new features
- GitHub [discussions](https://github.com/aspirepress/AspireSync/discussions) for disucssions
- GitHub [milstones](https://github.com/aspirepress/AspireSync/milestones) for tracking releases
- Slack channel [#aspiresync](https://app.slack.com/client/T07Q5LB7W23/C07QG6AUN4E)for discussions ([sign up form](https://aspirepress.org/slack/))

## 👥 The AspireSync Contributors

[AspireSync Contributors](https://github.com/aspirepress/AspireSync/graphs/contributors)



39 changes: 0 additions & 39 deletions docs/aspireupdate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ permalink: /aspireupdate/

# What is AspireUpdate?

# What is AspireUpdate?

[AspireUpdate](https://github.com/aspirepress/AspireUpdate) is an open source WordPress plugin that enables WordPress sites to use an alternative repository for updates. The plugin reverts to WordPress.org repository when updates are not available in the configured AspireCloud instance.
[AspireUpdate](https://github.com/aspirepress/AspireUpdate) is an open source WordPress plugin that enables WordPress sites to use an alternative repository for updates. The plugin reverts to WordPress.org repository when updates are not available in the configured AspireCloud instance.

Expand Down Expand Up @@ -117,51 +115,14 @@ Expected Results
✅ "Default API Found" entries should reference api.wordpress.org.
✅ "API Rerouted to" entries should reference api.aspirecloud.org.

## 👥 The AspireUpdate Contributors

[AspireUpdate Contributors](https://github.com/aspirepress/AspireUpdate/graphs/contributors)

## FAQs

Q: Why can’t I find the “Favorites” or “Features” tab when adding a new plugin or theme in AspireUpdate?
A: In the current version of AspireUpdate, the “Favorites” and “Features” tabs are unavailable due to compatibility limitations.

## 🚨Issues/Concerns

- Need another plugin dev/tester
- A REST API dev to develop the AspireCloud
- Need a technical architect for working out the overall design going forward
- Need testers!

## 📝 Upcoming topics

- Get feedback on proposed approach from AP community

## ✅ Action items

- Continue to document a technical architecture
- Divide labour and create projects and tasks and milestones @Yosef Eliezrie

## 🔑 Key links

- Slack: See [#aspireupdate](https://app.slack.com/client/T07Q5LB7W23/C07Q88M2KQF) for discussion

### Configuration

By default the plugin is accessing the api.aspirecloud.org endpoint. There should be no other configuration required. You can turn on the debug log and reset the settings. Use the advanced=true query param in the settings screen to turn on advanced configuration settings.

## Contributing

AspirePress welcomes contributions from people like you. We encourage you to review
our [Contribution Guidelines](https://github.com/aspirepress/.github/blob/main/CONTRIBUTING.md).

## Code of Conduct

AspirePress also implements a [Code of Conduct](https://github.com/aspirepress/.github/blob/main/CODE_OF_CONDUCT.md),
adherence to which is required by all members of the project.

## Credits

AspirePress is a community project, powered by people just like you. Thank you to
our [contributors](https://github.com/aspirepress/.github/blob/main/CREDITS.md) for their generous participation in
AspirePress.
29 changes: 29 additions & 0 deletions docs/aspireupdate/work.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
layout: default
title: Welcome to AspireUpdate
permalink: /aspireupdate/work/
---

# Work on AspireUpdate



## 🚨 Help Required

- We need plugin developers
- We need plugin testers
- We need a technical architect for working out the overall design going forward


## 📝 Issues, Milestones and Dicussions

- GitHub [issues](https://github.com/aspirepress/AspireUpdate/issues) for tracking bugs and new features
- GitHub [discussions](https://github.com/aspirepress/AspireUpdate/discussions) for disucssions
- GitHub [milstones](https://github.com/aspirepress/AspireUpdate/milestones) for tracking releases
- Slack channel [#aspireupdate](https://app.slack.com/client/T07Q5LB7W23/C07Q88M2KQF) for discussions [sign up form](https://aspirepress.org/slack/)

## 👥 The AspireUpdate Contributors

[AspireUpdate Contributors](https://github.com/aspirepress/AspireUpdate/graphs/contributors)


11 changes: 11 additions & 0 deletions docs/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
layout: default
title: Welcome to AspirePress
permalink: /code-of-conduct/
---

# Code of Conduct

AspirePress also implements a [Code of Conduct](https://github.com/aspirepress/.github/blob/main/CODE_OF_CONDUCT.md),
adherence to which is required by all members of the project.

11 changes: 11 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
layout: default
title: Welcome to AspirePress
permalink: /contributing/
---

# Contributing

AspirePress welcomes contributions from people like you. We encourage you to review
our [Contribution Guidelines](https://github.com/aspirepress/.github/blob/main/CONTRIBUTING.md).

12 changes: 12 additions & 0 deletions docs/credits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: default
title: Welcome to AspirePress
permalink: /credits/
---


# Credits

AspirePress is a community project, powered by people just like you. Thank you to
our [contributors](https://github.com/aspirepress/.github/blob/main/CREDITS.md) for their generous participation in
AspirePress.

0 comments on commit 25059d4

Please sign in to comment.