Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Figure out way to have theme directory be "isoc-wp" #9

Closed
danyork opened this Issue · 4 comments

1 participant

@danyork
Owner

In the readme.markdown file I wrote that the theme would be installed into the directory "isoc-wp". However, it seems that when you download from the Github Tags page you get a zip file that installs into a directory named:

InternetSociety-isoc-wp-commitnumber

When you then upload the theme to WordPress it installs into this directory.

There is no inherent problem with this and in fact it pretty much ensures that it will NOT overwrite another theme that happens to use "isoc-wp" ... BUT... if people later use a child theme, they will need to modify the child theme to point over to the main parent theme located in this directory.

It would be simpler if the ZIP file could just unzip into a "isoc-wp" directory. However, that may not be possible within the Github framework of using tag-based downloads... which I want to continue to use so that the automatic update plugin works.

More investigation on this needs to occur...

@danyork danyork was assigned
@danyork
Owner

I'll note that and added problem here is that if the ZIP file doesn't unzip into a common directory (like 'isoc-wp'), then the instructions in the readme for linking to the social media icons need even more customization - and will potentially be different for every person using this.

The problem is that I want to give people some copy-and-paste code examples to add in as sidebar widgets. Specifically, I want them to be able to get to some social media icons we've included with the theme. So in my readme I have this as an example:

<img src="/wp-content/themes/isoc-wp/images/icon_facebook_lg.png" width="28" height="29" alt="facebook">

However, this doesn't work... it really has to be:

<img src="/wp-content/themes/InternetSociety-isoc-wp-<commit#>/images/icon_facebook_lg.png" width="28" height="29" alt="facebook">

and so the chapter web administrator has to figure out the directory name they need to use in that string.

Not a huge deal, but just one more thing an administrator has to do to get set up with the theme.

Another approach would be to NOT use the tag-based approach but instead manually create ZIP files that get added to the "Downloads" page. This would then rule out use of the Theme Updater automatic update plugin - so I'd really rather NOT do this.

@danyork
Owner

A note on this last approach... I could manually create a ZIP file with the "isoc-wp" directory name and upload it to the repo downloads page ( https://github.com/InternetSociety/isoc-wp/downloads ). I then instruct people to download that ZIP file first to bootstrap the process and then auto-updates continue to use this same directory name.

The Installation Instructions are then changed to tell people to grab the latest file from the Downloads page instead of the Tags page.

@danyork
Owner

Noting for myself that the command to create a "bootstrap" ZIP file that uses "isoc-wp" would be:

git archive --format zip --output ../isoc-wp-v1.0.6.zip --prefix=isoc-wp/ master

This would give me a ZIP file with the name isoc-wp-<version>.zip that would unzip into isoc-wp.

From my testing so far, it seems that the automatic updates via the Theme Updater plugin still work perfectly fine and they do NOT change the directory name. That name is set only upon the initial upload of the theme.

@danyork
Owner

I communicated with the Github staff and confirmed that the only way to do this is to do what I wrote in comments of having a specific download on the Downloads page that people use to bootstrap the process.

That works - and is just a change to the documentation.

@danyork danyork referenced this issue from a commit
@danyork danyork Fixes issue #9 with change to download location and moved automatic u…
…pdates up in readme file

I want the automatic updates to appear earlier in the readme file so
that people know about them.  Where they were after all the
configuration steps was a recipe for them to NOT be noticed.
48efee5
@danyork danyork closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.